autoCmd
autocmd definitions
Type: list of (submodule)
Default: [ ]
Example:
''
autoCmd = [
{
event = [ "BufEnter" "BufWinEnter" ];
pattern = [ "*.c" "*.h" ];
command = "echo 'Entering a C or C++ file'";
}
];
''
Declared by:
autoCmd.*.buffer
Buffer number for buffer local autocommands |autocmd-buflocal|. Cannot be used with pattern.
Type: null or signed integer
Default: null
Declared by:
autoCmd.*.callback
A function or a string.
-
if a string, the name of a Vimscript function to call when this autocommand is triggered.
-
Otherwise, a Lua function which is called when this autocommand is triggered. Cannot be used with
command. Lua callbacks can return true to delete the autocommand; in addition, they accept a single table argument with the following keys:-
id: (number) the autocommand id
-
event: (string) the name of the event that triggered the autocommand |autocmd-events|
-
group: (number|nil) the autocommand group id, if it exists
-
match: (string) the expanded value of |<amatch>|
-
buf: (number) the expanded value of |<abuf>|
-
file: (string) the expanded value of |<afile>|
-
data: (any) arbitrary data passed to |nvim_exec_autocmds()|
-
Example using callback: autoCmd = [ { event = [ “BufEnter” “BufWinEnter” ]; pattern = [ “.c" ".h” ]; callback = { __raw = “function() print(‘This buffer enters’) end”; }; }
Type: null or string or (submodule)
Default: null
Declared by:
autoCmd.*.command
Vim command to execute on event. Cannot be used with callback.
default: ``
Type: null or string
Default: null
Declared by:
autoCmd.*.description
A textual description of this autocommand.
Type: null or string
Default: null
Declared by:
autoCmd.*.event
The event or events to register this autocommand.
Type: null or string or list of string
Default: null
Declared by:
autoCmd.*.group
The autocommand group name or id to match against.
Type: null or string or signed integer
Default: null
Declared by:
autoCmd.*.nested
Run nested autocommands.
default: false
Type: null or boolean
Default: null
Declared by:
autoCmd.*.once
Run the autocommand only once.
default: false
Type: null or boolean
Default: null
Declared by:
autoCmd.*.pattern
Pattern or patterns to match literally against.
Type: null or string or list of string
Default: null
Declared by:
autoGroups
augroup definitions
Type: attribute set of (submodule)
Default: { }
Example:
''
autoGroups = {
my_augroup = {
clear = true;
}
};
''
Declared by:
autoGroups.<name>.clear
Clear existing commands if the group already exists.
Type: boolean
Default: true
Declared by:
clipboard.providers
Package(s) to use as the clipboard provider. Learn more at :h clipboard.
Type: submodule
Default: { }
Declared by:
clipboard.providers.wl-copy.enable
Whether to enable wl-copy.
Type: boolean
Default: false
Example: true
Declared by:
clipboard.providers.wl-copy.package
The wl-clipboard package to use.
Type: package
Default: pkgs.wl-clipboard
Declared by:
clipboard.providers.xclip.enable
Whether to enable xclip.
Type: boolean
Default: false
Example: true
Declared by:
clipboard.providers.xclip.package
The xclip package to use.
Type: package
Default: pkgs.xclip
Declared by:
clipboard.providers.xsel.enable
Whether to enable xsel.
Type: boolean
Default: false
Example: true
Declared by:
clipboard.providers.xsel.package
The xsel package to use.
Type: package
Default: pkgs.xsel
Declared by:
clipboard.register
Sets the register to use for the clipboard. Learn more at https://neovim.io/doc/user/options.html#‘clipboard’;.
Type: null or string or list of string
Default: null
Example: "unnamedplus"
Declared by:
colorscheme
The name of the colorscheme to use
Type: null or string
Default: null
Declared by:
colorschemes.base16.enable
Whether to enable base16.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.base16.package
Plugin to use for base16
Type: package
Default: <derivation vimplugin-nvim-base16-2023-05-13>
Declared by:
colorschemes.base16.colorscheme
The base16 colorscheme to use
Type: one of “3024”, “apathy”, “apprentice”, “ashes”, “atelier-cave-light”, “atelier-cave”, “atelier-dune-light”, “atelier-dune”, “atelier-estuary-light”, “atelier-estuary”, “atelier-forest-light”, “atelier-forest”, “atelier-heath-light”, “atelier-heath”, “atelier-lakeside-light”, “atelier-lakeside”, “atelier-plateau-light”, “atelier-plateau”, “atelier-savanna-light”, “atelier-savanna”, “atelier-seaside-light”, “atelier-seaside”, “atelier-sulphurpool-light”, “atelier-sulphurpool”, “atlas”, “ayu-dark”, “ayu-light”, “ayu-mirage”, “bespin”, “black-metal-bathory”, “black-metal-burzum”, “black-metal-dark-funeral”, “black-metal-gorgoroth”, “black-metal-immortal”, “black-metal-khold”, “black-metal-marduk”, “black-metal-mayhem”, “black-metal-nile”, “black-metal-venom”, “black-metal”, “blueforest”, “blueish”, “brewer”, “bright”, “brogrammer”, “brushtrees-dark”, “brushtrees”, “catppuccin”, “chalk”, “circus”, “classic-dark”, “classic-light”, “codeschool”, “colors”, “cupcake”, “cupertino”, “danqing”, “da-one-black”, “da-one-gray”, “da-one-ocean”, “da-one-paper”, “da-one-sea”, “da-one-white”, “darcula”, “darkmoss”, “darktooth”, “darkviolet”, “decaf”, “default-dark”, “default-light”, “dirtysea”, “dracula”, “edge-dark”, “edge-light”, “eighties”, “embers”, “emil”, “equilibrium-dark”, “equilibrium-gray-dark”, “equilibrium-gray-light”, “equilibrium-light”, “espresso”, “eva-dim”, “eva”, “everforest”, “flat”, “framer”, “fruit-soda”, “gigavolt”, “github”, “google-dark”, “google-light”, “gotham”, “grayscale-dark”, “grayscale-light”, “greenscreen”, “gruber”, “gruvbox-dark-hard”, “gruvbox-dark-medium”, “gruvbox-dark-pale”, “gruvbox-dark-soft”, “gruvbox-light-hard”, “gruvbox-light-medium”, “gruvbox-light-soft”, “gruvbox-material-dark-hard”, “gruvbox-material-dark-medium”, “gruvbox-material-dark-soft”, “gruvbox-material-light-hard”, “gruvbox-material-light-medium”, “gruvbox-material-light-soft”, “hardcore”, “harmonic-dark”, “harmonic-light”, “heetch-light”, “heetch”, “helios”, “hopscotch”, “horizon-dark”, “horizon-light”, “horizon-terminal-dark”, “horizon-terminal-light”, “humanoid-dark”, “humanoid-light”, “ia-dark”, “ia-light”, “icy”, “irblack”, “isotope”, “kanagawa”, “katy”, “kimber”, “lime”, “macintosh”, “marrakesh”, “material-darker”, “material-lighter”, “material-palenight”, “material-vivid”, “material”, “materia”, “mellow-purple”, “mexico-light”, “mocha”, “monokai”, “nebula”, “nord”, “nova”, “oceanicnext”, “ocean”, “onedark”, “one-light”, “outrun-dark”, “pandora”, “papercolor-dark”, “papercolor-light”, “paraiso”, “pasque”, “phd”, “pico”, “pinky”, “pop”, “porple”, “primer-dark-dimmed”, “primer-dark”, “primer-light”, “purpledream”, “qualia”, “railscasts”, “rebecca”, “rose-pine-dawn”, “rose-pine-moon”, “rose-pine”, “sagelight”, “sakura”, “sandcastle”, “seti”, “shadesmear-dark”, “shadesmear-light”, “shades-of-purple”, “shapeshifter”, “silk-dark”, “silk-light”, “snazzy”, “solarflare-light”, “solarflare”, “solarized-dark”, “solarized-light”, “spaceduck”, “spacemacs”, “stella”, “still-alive”, “summercamp”, “summerfruit-dark”, “summerfruit-light”, “synth-midnight-dark”, “synth-midnight-light”, “tango”, “tender”, “tokyo-city-dark”, “tokyo-city-light”, “tokyo-city-terminal-dark”, “tokyo-city-terminal-light”, “tokyodark-terminal”, “tokyodark”, “tokyo-night-dark”, “tokyo-night-light”, “tokyo-night-storm”, “tokyo-night-terminal-dark”, “tokyo-night-terminal-light”, “tokyo-night-terminal-storm”, “tomorrow-night-eighties”, “tomorrow-night”, “tomorrow”, “tube”, “twilight”, “unikitty-dark”, “unikitty-light”, “unikitty-reversible”, “uwunicorn”, “vice”, “vulcan”, “windows-10-light”, “windows-10”, “windows-95-light”, “windows-95”, “windows-highcontrast-light”, “windows-highcontrast”, “windows-nt-light”, “windows-nt”, “woodland”, “xcode-dusk”, “zenburn”
Default: "3024"
Declared by:
colorschemes.base16.setUpBar
Whether to install the matching plugin for your statusbar. This does nothing as of yet, waiting for upstream support.
Type: boolean
Default: true
Declared by:
colorschemes.base16.useTruecolor
Whether to use truecolor for the colorschemes. If set to false, you’ll need to set up base16 in your shell.
Type: boolean
Default: true
Declared by:
colorschemes.catppuccin.enable
Whether to enable catppuccin.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.catppuccin.package
Plugin to use for catppuccin
Type: package
Default: <derivation vimplugin-catppuccin-nvim-2023-07-07>
Declared by:
colorschemes.catppuccin.background.dark
Background for dark
default: "latte"
Type: null or one of “latte”, “mocha”, “frappe”, “macchiato”
Default: null
Declared by:
colorschemes.catppuccin.background.light
Background for light
default: "latte"
Type: null or one of “latte”, “mocha”, “frappe”, “macchiato”
Default: null
Declared by:
colorschemes.catppuccin.colorOverrides.all
Override colors for all of the flavours.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.catppuccin.colorOverrides.frappe
Override colors for the frappe flavour.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.catppuccin.colorOverrides.latte
Override colors for the latte flavour.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.catppuccin.colorOverrides.macchiato
Override colors for the macchiato flavour.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.catppuccin.colorOverrides.mocha
Override colors for the mocha flavour.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.catppuccin.customHighlights
Override specific highlight groups to use other groups or a hex color Example: function(colors) return { Comment = { fg = colors.flamingo }, [“@constant.builtin”] = { fg = colors.peach, style = {} }, [“@comment”] = { fg = colors.surface2, style = { “italic” } }, } end
default: ``
Type: null or string or attribute set of (attribute set)
Default: null
Declared by:
colorschemes.catppuccin.dimInactive.enabled
if true, dims the background color of inactive window or buffer or split
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.dimInactive.percentage
percentage of the shade to apply to the inactive window, split or buffer
default: 0.15
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
colorschemes.catppuccin.dimInactive.shade
sets the shade to apply to the inactive split or window or buffer
default: dark
Type: null or string
Default: null
Declared by:
colorschemes.catppuccin.disableBold
Force no bold
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.disableItalic
Force no italic
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.flavour
Theme flavour
default: "latte"
Type: null or one of “latte”, “mocha”, “frappe”, “macchiato”
Default: null
Declared by:
colorschemes.catppuccin.integrations.aerial
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.barbar
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.barbecue.alt_background
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.barbecue.bold_basename
default: true
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.barbecue.dim_context
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.barbecue.dim_dirname
default: true
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.beacon
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.cmp
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.coc_nvim
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.dap.enable_ui
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.dap.enabled
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.dashboard
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.fern
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.fidget
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.gitgutter
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.gitsigns
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.harpoon
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.headlines
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.hop
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.illuminate
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.indent_blankline.enabled
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.indent_blankline.colored_indent_levels
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.leap
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.lightspeed
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.lsp_saga
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.lsp_trouble
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.markdown
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.mason
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.mini
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.enabled
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.underlines.errors
default: [ "underline" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.underlines.hints
default: [ "underline" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.underlines.information
default: [ "underline" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.underlines.warnings
default: [ "underline" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.virtual_text.errors
default: [ "italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.virtual_text.hints
default: [ "italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.virtual_text.information
default: [ "italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.native_lsp.virtual_text.warnings
default: [ "italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.integrations.navic.enabled
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.navic.custom_bg
default: NONE
Type: null or string
Default: null
Declared by:
colorschemes.catppuccin.integrations.neogit
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.neotest
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.neotree
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.noice
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.notify
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.nvimtree
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.octo
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.overseer
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.pounce
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.sandwich
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.semantic_tokens
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.symbols_outline
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.telekasten
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.telescope
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.treesitter
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.treesitter_context
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.ts_rainbow
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.ts_rainbow2
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.vim_sneak
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.vimwiki
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.integrations.which_key
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.showBufferEnd
show the ‘~’ characters after the end of buffers
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.styles.booleans
Define booleans highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.comments
Define comments highlight properties
default: [ "italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.conditionals
Define conditionals highlight properties
default: [ 'italic" ]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.functions
Define functions highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.keywords
Define keywords highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.loops
Define loops highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.numbers
Define numbers highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.operators
Define operators highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.properties
Define properties highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.strings
Define strings highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.types
Define types highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.styles.variables
Define variables highlight properties
default: []
Type: null or (list of string)
Default: null
Declared by:
colorschemes.catppuccin.terminalColors
Configure the colors used when opening a :terminal in Neovim
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.catppuccin.transparentBackground
Enable Transparent background
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.gruvbox.enable
Whether to enable gruvbox.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.package
Plugin to use for gruvbox
Type: package
Default: <derivation vimplugin-gruvbox.nvim-2023-04-23>
Declared by:
colorschemes.gruvbox.bold
Whether to enable bold.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.colorColumn
The color column background
Type: null or one of “bg”, “red”, “green”, “yellow”, “blue”, “purple”, “aqua”, “gray”, “fg”, “bg0_h”, “bg0”, “bg1”, “bg2”, “bg3”, “bg4”, “gray”, “orange”, “bg0_s”, “fg0”, “fg1”, “fg2”, “fg3”, “fg4”
Default: null
Declared by:
colorschemes.gruvbox.contrastDark
Contrast for the dark mode
Type: null or one of “soft”, “medium”, “hard”
Default: null
Declared by:
colorschemes.gruvbox.contrastLight
Contrast for the light mode
Type: null or one of “soft”, “medium”, “hard”
Default: null
Declared by:
colorschemes.gruvbox.highlightSearchCursor
The cursor background while search is highlighted
Type: null or one of “bg”, “red”, “green”, “yellow”, “blue”, “purple”, “aqua”, “gray”, “fg”, “bg0_h”, “bg0”, “bg1”, “bg2”, “bg3”, “bg4”, “gray”, “orange”, “bg0_s”, “fg0”, “fg1”, “fg2”, “fg3”, “fg4”
Default: null
Declared by:
colorschemes.gruvbox.improvedStrings
Improved strings
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.improvedWarnings
Improved warnings
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.invertIndentGuides
Invert indent guides
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.invertSelection
Invert the select text
Type: boolean
Default: true
Declared by:
colorschemes.gruvbox.invertSigns
Invert GitGutter and Syntastic signs
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.invertTabline
Invert tabline highlights
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.italicizeComments
Italicize comments
Type: boolean
Default: true
Declared by:
colorschemes.gruvbox.italicizeStrings
Italicize strings
Type: boolean
Default: false
Declared by:
colorschemes.gruvbox.italics
Whether to enable italics.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.numberColumn
The number column background
Type: null or one of “bg”, “red”, “green”, “yellow”, “blue”, “purple”, “aqua”, “gray”, “fg”, “bg0_h”, “bg0”, “bg1”, “bg2”, “bg3”, “bg4”, “gray”, “orange”, “bg0_s”, “fg0”, “fg1”, “fg2”, “fg3”, “fg4”
Default: null
Declared by:
colorschemes.gruvbox.signColumn
The sign column background
Type: null or one of “bg”, “red”, “green”, “yellow”, “blue”, “purple”, “aqua”, “gray”, “fg”, “bg0_h”, “bg0”, “bg1”, “bg2”, “bg3”, “bg4”, “gray”, “orange”, “bg0_s”, “fg0”, “fg1”, “fg2”, “fg3”, “fg4”
Default: null
Declared by:
colorschemes.gruvbox.transparentBg
Whether to enable transparent background.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.trueColor
Whether to enable true color support.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.undercurl
Whether to enable undercurled text.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.underline
Whether to enable underlined text.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.gruvbox.vertSplitColor
The vertical split background color
Type: null or one of “bg”, “red”, “green”, “yellow”, “blue”, “purple”, “aqua”, “gray”, “fg”, “bg0_h”, “bg0”, “bg1”, “bg2”, “bg3”, “bg4”, “gray”, “orange”, “bg0_s”, “fg0”, “fg1”, “fg2”, “fg3”, “fg4”
Default: null
Declared by:
colorschemes.kanagawa.enable
Whether to enable kanagawa.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.kanagawa.package
Plugin to use for kanagawa
Type: package
Default: <derivation vimplugin-kanagawa.nvim-2023-06-21>
Declared by:
colorschemes.kanagawa.background.dark
The theme to use when vim.o.background = "dark".
default: wave
Type: null or string
Default: null
Declared by:
colorschemes.kanagawa.background.light
The theme to use when vim.o.background = "light".
default: lotus
Type: null or string
Default: null
Declared by:
colorschemes.kanagawa.colors.palette
Change all usages of these colors.
Example:
{
sumiInk0 = "#000000";
fujiWhite = "#FFFFFF";
}
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
colorschemes.kanagawa.colors.theme
Change specific usages for a certain theme, or for all of them
Example:
{
wave = {
ui = {
float = {
bg = "none";
};
};
};
dragon = {
syn = {
parameter = "yellow";
};
};
all = {
ui = {
bg_gutter = "none";
};
};
}
default: { wave = {}; lotus = {}; dragon = {}; all = {}; }
Type: null or (attribute set of (attribute set))
Default: null
Declared by:
colorschemes.kanagawa.commentStyle
Highlight options for comments.
default: {italic = true;}
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.kanagawa.compile
Enable compiling the colorscheme.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.kanagawa.dimInactive
Whether dim inactive window :h hl-NormalNC.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.kanagawa.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
colorschemes.kanagawa.functionStyle
Highlight options for functions.
default: {}
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.kanagawa.keywordStyle
Highlight options for keywords.
default: {italic = true;}
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.kanagawa.overrides
The body of a function that add/modify hihlights. It takes as input a colors argument which is a table of this form:
colors = {
palette = {
foo = "#RRGGBB",
bar = "#RRGGBB"
},
theme = {
foo = "#RRGGBB",
bar = "#RRGGBB"
}
}
It should return a table of highlights.
function(colors)
CONTENT_OF_OVERRIDE_OPTION
end
default: return {}
Type: null or string
Default: null
Declared by:
colorschemes.kanagawa.statementStyle
Highlight options for statements.
default: {bold = true;}
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.kanagawa.terminalColors
If true, defines vim.g.terminal_color_{0,17}.
default: true
Type: null or boolean
Default: null
Declared by:
colorschemes.kanagawa.theme
The theme to load when background is not set.
default: wave
Type: null or string
Default: null
Declared by:
colorschemes.kanagawa.transparent
Whether to set a background color.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.kanagawa.typeStyle
Highlight options for types.
default: {}
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.kanagawa.undercurl
Enable undercurls.
default: true
Type: null or boolean
Default: null
Declared by:
colorschemes.nord.enable
Whether to enable nord.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.enable_sidebar_background
Whether to enable Re-enables the background of the sidebar if you disabled the background of everything.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.package
Plugin to use for nord.vim
Type: package
Default: <derivation vimplugin-nord.nvim-2023-03-26>
Declared by:
colorschemes.nord.borders
Whether to enable Enable the border between verticaly split windows visable.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.contrast
Whether to enable Make sidebars and popup menus like nvim-tree and telescope have a different background.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.cursorline_transparent
Whether to enable Set the cursorline transparent/visible.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.disable_background
Whether to enable Disable the setting of background color so that NeoVim can use your terminal background.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.nord.italic
enables/disables italics
Type: null or boolean
Default: null
Declared by:
colorschemes.one.enable
Whether to enable vim-one.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.one.package
Plugin to use for one
Type: package
Default: <derivation vimplugin-vim-one-2020-12-14>
Declared by:
colorschemes.onedark.enable
Whether to enable onedark.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.onedark.package
Plugin to use for one
Type: package
Default: <derivation vimplugin-onedark.vim-2023-05-02>
Declared by:
colorschemes.oxocarbon.enable
Whether to enable oxocarbon.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.oxocarbon.package
Plugin to use for oxocarbon
Type: package
Default: <derivation vimplugin-oxocarbon.nvim-2023-06-06>
Declared by:
colorschemes.poimandres.enable
Whether to enable poimandres.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.poimandres.package
Plugin to use for poimandres
Type: package
Default: <derivation vimplugin-poimandres.nvim-2023-02-17>
Declared by:
colorschemes.poimandres.boldVertSplit
bold vertical split
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.poimandres.darkVariant
dark variant
default: main
Type: null or string
Default: null
Declared by:
colorschemes.poimandres.dimNcBackground
Dim NC background
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.poimandres.disableBackground
Whether to disable the background.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.poimandres.disableFloatBackground
Whether to disable the float background.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.poimandres.disableItalics
Whether to disable italics.
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.poimandres.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
colorschemes.poimandres.groups
groups
Type: null or (attribute set of (string or attribute set of string))
Default: null
Declared by:
colorschemes.poimandres.highlightGroups
highlight groups
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.rose-pine.enable
Whether to enable rose-pine.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.rose-pine.package
Plugin to use for rose-pine
Type: package
Default: <derivation vimplugin-rose-pine-2023-06-21>
Declared by:
colorschemes.rose-pine.boldVerticalSplit
Bolds vertical splits
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.rose-pine.dimInactive
Dims inactive windows
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.rose-pine.disableItalics
Disables italics
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.rose-pine.groups
rose-pine highlight groups
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.rose-pine.highlightGroups
Custom highlight groups
Type: null or (attribute set)
Default: null
Declared by:
colorschemes.rose-pine.style
Theme style
default: "main"
Type: null or one of “main”, “moon”, “dawn”
Default: null
Declared by:
colorschemes.rose-pine.transparentBackground
Disable setting background
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.rose-pine.transparentFloat
Disable setting background for floating windows
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.tokyonight.enable
Whether to enable tokyonight.
Type: boolean
Default: false
Example: true
Declared by:
colorschemes.tokyonight.package
Plugin to use for tokyonight
Type: package
Default: <derivation vimplugin-tokyonight.nvim-2023-07-05>
Declared by:
colorschemes.tokyonight.dayBrightness
Adjusts the brightness of the colors of the Day style
default: 0.3
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
colorschemes.tokyonight.dimInactive
dims inactive windows
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.tokyonight.hideInactiveStatusline
Enabling this option will hide inactive statuslines and replace them with a thin border
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.tokyonight.lualineBold
When true, section headers in the lualine theme will be bold
default: false
Type: null or boolean
Default: null
Declared by:
colorschemes.tokyonight.onColors
Override specific color groups to use other groups or a hex color. function will be called with a ColorScheme table. @param colors ColorScheme
default: function(colors) end
Type: null or string
Default: null
Declared by:
colorschemes.tokyonight.onHighlights
Override specific highlights to use other groups or a hex color. function will be called with a Highlights and ColorScheme table @param highlights Highlights @param colors ColorScheme
default: function(highlights, colors) end
Type: null or string
Default: null
Declared by:
colorschemes.tokyonight.sidebars
Set a darker background on sidebar-like windows
default: ["qf" "help"]
Type: null or (list of string)
Default: null
Declared by:
colorschemes.tokyonight.style
Theme style
default: "storm"
Type: null or one of “storm”, “night”, “day”
Default: null
Declared by:
colorschemes.tokyonight.styles.comments
Define comments highlight properties
default: {italic = true;}
Type: null or (attribute set of anything)
Default: null
Declared by:
colorschemes.tokyonight.styles.floats
Background style for floats
default: "dark"
Type: null or one of “dark”, “transparent”, “normal”
Default: null
Declared by:
colorschemes.tokyonight.styles.functions
Define functions highlight properties
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
colorschemes.tokyonight.styles.keywords
Define keywords highlight properties
default: {italic = true;}
Type: null or (attribute set of anything)
Default: null
Declared by:
colorschemes.tokyonight.styles.sidebars
Background style for sidebars
default: "dark"
Type: null or one of “dark”, “transparent”, “normal”
Default: null
Declared by:
colorschemes.tokyonight.styles.variables
Define variables highlight properties
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
colorschemes.tokyonight.terminalColors
Configure the colors used when opening a :terminal in Neovim
default: true
Type: null or boolean
Default: null
Declared by:
colorschemes.tokyonight.transparent
disable setting the background color
default: false
Type: null or boolean
Default: null
Declared by:
editorconfig.enable
editorconfig plugin for neovim
Type: boolean
Default: true
Declared by:
editorconfig.properties
The table key is a property name and the value is a callback function which accepts the number of the buffer to be modified, the value of the property in the .editorconfig file, and (optionally) a table containing all of the other properties and their values (useful for properties which depend on other properties). The value is always a string and must be coerced if necessary.
Type: attribute set of string
Default: { }
Example:
{
foo = ''
function(bufnr, val, opts)
if opts.charset and opts.charset ~= "utf-8" then
error("foo can only be set when charset is utf-8", 0)
end
vim.b[bufnr].foo = val
end
'';
}
Declared by:
extraConfigLua
Extra contents for the file
Type: strings concatenated with “\n”
Default: ""
Declared by:
extraConfigLuaPost
Extra contents for the file after everything else
Type: strings concatenated with “\n”
Default: ""
Declared by:
extraConfigLuaPre
Extra contents for the file before everything else
Type: strings concatenated with “\n”
Default: ""
Declared by:
extraConfigVim
Extra contents for the file, in vimscript
Type: strings concatenated with “\n”
Default: ""
Declared by:
extraFiles
Extra files to add to the runtime path
Type: attribute set of string
Default: { }
Declared by:
extraLuaPackages
Extra lua packages to include with neovim
Type: function that evaluates to a(n) list of package
Default: <function>
Declared by:
extraPackages
Extra packages to be made available to neovim
Type: list of package
Default: [ ]
Declared by:
extraPlugins
List of vim plugins to install
Type: list of (package or (submodule))
Default: [ ]
Declared by:
filetype
Define additional filetypes. The values can either be a literal filetype or a function taking the filepath and the buffer number.
For more information check :h vim.filetype.add()
Type: null or (submodule)
Default: null
Declared by:
filetype.extension
set filetypes matching the file extension
Type: null or (attribute set of (string or (submodule) or list of (string or (submodule))))
Default: null
Declared by:
filetype.filename
set filetypes matching the file name (or path)
Type: null or (attribute set of (string or (submodule) or list of (string or (submodule))))
Default: null
Declared by:
filetype.pattern
set filetypes matching the specified pattern
Type: null or (attribute set of (string or (submodule) or list of (string or (submodule))))
Default: null
Declared by:
globals
Global variables
Type: attribute set of anything
Default: { }
Declared by:
highlight
Define highlight groups
Type: attribute set of anything
Default: { }
Example:
''
highlight = {
Comment.fg = '#ff0000';
};
''
Declared by:
luaLoader.enable
Whether to enable/disable the experimental lua loader:
If true: Enables the experimental Lua module loader:
-
overrides loadfile
-
adds the lua loader using the byte-compilation cache
-
adds the libs loader
-
removes the default Neovim loade
If false: Disables the experimental Lua module loader:
-
removes the loaders
-
adds the default Neovim loader
Type: boolean
Default: false
Declared by:
maps
Custom keybindings for any mode.
For plain maps (e.g. just ‘map’ or ‘remap’) use maps.normalVisualOp.
Type: submodule
Default: { }
Example:
''
maps = {
normalVisualOp.";" = ":"; # Same as noremap ; :
normal."<leader>m" = {
silent = true;
action = "<cmd>make<CR>";
}; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
};
''
Declared by:
maps.command
Mappings for command-line mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.insert
Mappings for insert mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.insertCommand
Mappings for insert and command-line mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.lang
Mappings for insert, command-line and lang-arg mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.normal
Mappings for normal mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.normalVisualOp
Mappings for normal, visual, select and operator-pending (same as plain ‘map’) mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.operator
Mappings for operator-pending mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.select
Mappings for select mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.terminal
Mappings for terminal mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.visual
Mappings for visual and select mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
maps.visualOnly
Mappings for visual only mode
Type: attribute set of (string or (submodule))
Default: { }
Declared by:
match
Define match groups
Type: attribute set of string
Default: { }
Example:
''
match = {
ExtraWhitespace = '\\s\\+$';
};
''
Declared by:
options
The configuration options, e.g. line numbers
Type: attribute set of anything
Default: { }
Declared by:
path
Path of the file relative to the config directory
Type: string
Declared by:
plugins.airline.enable
Whether to enable airline.
Type: boolean
Default: false
Example: true
Declared by:
plugins.airline.package
Plugin to use for airline
Type: package
Default: <derivation vimplugin-vim-airline-2023-05-25>
Declared by:
plugins.airline.extensions
A list of extensions and their configuration
Type: null or (attribute set)
Default: null
Declared by:
plugins.airline.onTop
Whether to show the statusline on the top instead of the bottom
Type: boolean
Default: false
Declared by:
plugins.airline.powerline
Whether to use powerline symbols
Type: boolean
Default: false
Declared by:
plugins.airline.sections
Statusbar sections
Type: null or (submodule)
Default: null
Declared by:
plugins.airline.sections.a
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.sections.b
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.sections.c
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.sections.x
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.sections.y
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.sections.z
Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.
Type: null or string or list of string
Default: null
Declared by:
plugins.airline.theme
The theme to use for vim-airline. If set, vim-airline-themes will be installed.
Type: null or string
Default: null
Declared by:
plugins.alpha.enable
Whether to enable alpha.
Type: boolean
Default: false
Example: true
Declared by:
plugins.alpha.package
Plugin to use for alpha
Type: package
Default: <derivation vimplugin-alpha-nvim-2023-06-09>
Declared by:
plugins.alpha.iconsEnabled
Toggle icon support. Installs nvim-web-devicons.
Type: boolean
Default: true
Declared by:
plugins.alpha.layout
List of sections to layout for the dashboard
Type: list of (submodule)
Default:
[
{
type = "padding";
val = 2;
}
{
opts = {
hl = "Type";
position = "center";
};
type = "text";
val = [
" ███╗ ██╗██╗██╗ ██╗██╗ ██╗██╗███╗ ███╗ "
" ████╗ ██║██║╚██╗██╔╝██║ ██║██║████╗ ████║ "
" ██╔██╗ ██║██║ ╚███╔╝ ██║ ██║██║██╔████╔██║ "
" ██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║ "
" ██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║ "
" ╚═╝ ╚═══╝╚═╝╚═╝ ╚═╝ ╚═══╝ ╚═╝╚═╝ ╚═╝ "
];
}
{
type = "padding";
val = 2;
}
{
type = "group";
val = [
{
command = "<CMD>ene <CR>";
desc = " New file";
shortcut = "e";
}
{
command = ":qa<CR>";
desc = " Quit Neovim";
shortcut = "SPC q";
}
];
}
{
type = "padding";
val = 2;
}
{
opts = {
hl = "Keyword";
position = "center";
};
type = "text";
val = "Inspiring quote here.";
}
]
Declared by:
plugins.alpha.layout.*.opts
Additional options for the section
Type: submodule
Default: { }
Declared by:
plugins.alpha.layout.*.opts.hl
HighlightGroup to apply
Type: string
Default: "Keyword"
Declared by:
plugins.alpha.layout.*.opts.margin
Margin for section
Type: signed integer
Default: 0
Declared by:
plugins.alpha.layout.*.opts.position
How to align section
Type: string
Default: "center"
Declared by:
plugins.alpha.layout.*.opts.spacing
Spacing between grouped components
Type: signed integer
Default: 0
Declared by:
plugins.alpha.layout.*.type
Type of section
Type: one of “group”, “padding”, “text”
Declared by:
plugins.alpha.layout.*.val
Value for section
Type: string or signed integer or list of (string or (submodule))
Default: null
Declared by:
plugins.auto-save.enable
Whether to enable auto-save.
Type: boolean
Default: false
Example: true
Declared by:
plugins.auto-save.enableAutoSave
Whether to start auto-save when the plugin is loaded.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.auto-save.package
Plugin to use for auto-save
Type: package
Default: <derivation vimplugin-auto-save.nvim-2022-11-01>
Declared by:
plugins.auto-save.callbacks.afterSaving
The code of the function that runs after doing the actual save.
Type: null or string
Default: null
Declared by:
plugins.auto-save.callbacks.beforeAssertingSave
The code of the function that runs before checking condition.
Type: null or string
Default: null
Declared by:
plugins.auto-save.callbacks.beforeSaving
The code of the function that runs before doing the actual save.
Type: null or string
Default: null
Declared by:
plugins.auto-save.callbacks.disabling
The code of the function that runs when disabling auto-save.
Type: null or string
Default: null
Declared by:
plugins.auto-save.callbacks.enabling
The code of the function that runs when enabling auto-save.
Type: null or string
Default: null
Declared by:
plugins.auto-save.condition
Function that determines whether to save the current buffer or not.
-
return true: if buffer is ok to be saved
-
return false: if it’s not ok to be saved
default: `function(buf) local fn = vim.fn local utils = require(“auto-save.utils.data”)
if fn.getbufvar(buf, “&modifiable”) == 1 and utils.not_in(fn.getbufvar(buf, “&filetype”), {}) then return true – met condition(s), can save end return false – can’t save end `
Type: null or string
Default: null
Declared by:
plugins.auto-save.debounceDelay
Saves the file at most every debounce_delay milliseconds.
default: 135
Type: null or signed integer
Default: null
Declared by:
plugins.auto-save.executionMessage.cleaningInterval
Time (in milliseconds) to wait before automatically cleaning MsgArea after displaying message. See :h MsgArea.
default: 1250
Type: null or signed integer
Default: null
Declared by:
plugins.auto-save.executionMessage.dim
Dim the color of message.
default: 0.18
Type: null or integer or floating point number between 0 and 1 (both inclusive)
Default: null
Declared by:
plugins.auto-save.executionMessage.message
The message to print en save. This can be a lua function that returns a string.
default: { __raw = \'\' function() return ("AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S")) end \'\'; }
Type: null or string or (submodule)
Default: null
Declared by:
plugins.auto-save.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.auto-save.keymaps.silent
Whether auto-save keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.auto-save.keymaps.toggle
Keymap for running auto-save.
Type: null or string
Default: null
Declared by:
plugins.auto-save.triggerEvents
Vim events that trigger auto-save. See :h events.
default: ["InsertLeave" "TextChanged"]
Type: null or (list of string)
Default: null
Declared by:
plugins.auto-save.writeAllBuffers
Write all buffers when the current one meets condition.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.enable
Whether to enable auto-session.
Type: boolean
Default: false
Example: true
Declared by:
plugins.auto-session.package
Plugin to use for auto-session
Type: package
Default: <derivation vimplugin-auto-session-2023-06-13>
Declared by:
plugins.auto-session.autoRestore.enabled
Whether to enable auto restoring session.
default: null
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.autoSave.enabled
Whether to enable auto saving session.
default: null
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.autoSession.enableLastSession
Whether to enable the “last session” feature.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.autoSession.enabled
Enables/disables auto creating, saving and restoring.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.autoSession.allowedDirs
Allow session create/restore if in one of the list of dirs.
Type: null or (list of string)
Default: null
Declared by:
plugins.auto-session.autoSession.createEnabled
Whether to enable auto creating new sessions
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.autoSession.rootDir
Root directory for session files. Can be either a string or lua code (using {__raw = 'foo';}).
default: {__raw = "vim.fn.stdpath 'data' .. '/sessions/'";}
Type: null or string or (submodule)
Default: null
Declared by:
plugins.auto-session.autoSession.suppressDirs
Suppress session create/restore if in one of the list of dirs.
Type: null or (list of string)
Default: null
Declared by:
plugins.auto-session.autoSession.useGitBranch
Include git branch name in session name to differentiate between sessions for different git branches.
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.bypassSessionSaveFileTypes
List of file types to bypass auto save when the only buffer open is one of the file types listed.
Type: null or (list of string)
Default: null
Declared by:
plugins.auto-session.cwdChangeHandling
Config for handling the DirChangePre and DirChanged autocmds. Set to false to disable the feature.
default: false
Type: null or value false (singular enum) or (submodule)
Default: null
Declared by:
plugins.auto-session.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.auto-session.logLevel
Sets the log level of the plugin.
default: "error"
Type: null or one of “debug”, “info”, “warn”, “error”
Default: null
Declared by:
plugins.auto-session.sessionLens.loadOnSetup
If loadOnSetup is set to false, one needs to eventually call require("auto-session").setup_session_lens() if they want to use session-lens.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.sessionLens.previewer
Use default previewer config by setting the value to null if some sets previewer to true in the custom config. Passing in the boolean value errors out in the telescope code with the picker trying to index a boolean instead of a table. This fixes it but also allows for someone to pass in a table with the actual preview configs if they want to.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.auto-session.sessionLens.sessionControl.controlDir
Auto session control dir, for control files, like alternating between two sessions with session-lens.
default: "vim.fn.stdpath 'data' .. '/auto_session/'"
Type: null or string or (submodule)
Default: null
Declared by:
plugins.auto-session.sessionLens.sessionControl.controlFilename
File name of the session control file.
default: session_control.json
Type: null or string
Default: null
Declared by:
plugins.auto-session.sessionLens.themeConf
Theme configuration.
default: {winblend = 10; border = true;}
Type: null or (attribute set)
Default: null
Declared by:
plugins.barbar.enable
Whether to enable barbar.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.barbar.package
Plugin to use for barbar
Type: package
Default: <derivation vimplugin-barbar.nvim-2023-07-05>
Declared by:
plugins.barbar.animation
Enable/disable animations
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.autoHide
Enable/disable auto-hiding the tab bar when there is a single buffer.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.clickable
Enable clickable tabs
-
left-click: go to buffer
-
middle-click: delete buffer
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.excludeFileNames
Excludes buffers with certain filenames from the tabline
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.barbar.excludeFileTypes
Excludes buffers of certain filetypes from the tabline
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.barbar.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.barbar.focusOnClose
A buffer to this direction will be focused (if it exists) when closing the current buffer.
default: "left"
Type: null or one of “left”, “right”
Default: null
Declared by:
plugins.barbar.hide.alternate
Hide alternate buffers
Type: null or boolean
Default: null
Declared by:
plugins.barbar.hide.current
Hide current buffer
Type: null or boolean
Default: null
Declared by:
plugins.barbar.hide.extensions
Hide file extensions
Type: null or boolean
Default: null
Declared by:
plugins.barbar.hide.inactive
Hide inactive buffers
Type: null or boolean
Default: null
Declared by:
plugins.barbar.hide.visible
Hide visible buffers
Type: null or boolean
Default: null
Declared by:
plugins.barbar.highlightAlternate
Highlight alternate buffers
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.highlightInactiveFileIcons
Highlight file icons in inactive buffers
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.highlightVisible
Highlight visible buffers
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate
The icons used for an alternate buffer.
Type: submodule
Default: { }
Declared by:
plugins.barbar.icons.alternate.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.modified.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.pinned.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.alternate.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.current
The icons for the current buffer.
Type: submodule
Default: { }
Declared by:
plugins.barbar.icons.current.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.modified.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.modified.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.modified.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.current.pinned.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.pinned.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.current.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive
The icons for inactive buffers.
Type: submodule
Default: { }
Declared by:
plugins.barbar.icons.inactive.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.modified.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.pinned.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.inactive.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.modified.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.modified.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.pinned.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.pinned.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible
The icons for visible buffers.
Type: submodule
Default: { }
Declared by:
plugins.barbar.icons.visible.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.modified.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.modified.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.modified.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.bufferIndex
Whether to show the index of the associated buffer with respect to the ordering of the buffers in the tabline.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.bufferNumber
Whether to show the bufnr for the associated buffer.
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.button
the button which is clicked to close / save a buffer, or indicate that it is pinned.
Type: null or string or value false (singular enum)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics
Diagnostics icons
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.error
error diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.error.enable
Enable the error diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.error.icon
error diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.hint
hint diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.hint.enable
Enable the hint diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.hint.icon
hint diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.info
info diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.info.enable
Enable the info diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.info.icon
info diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.warn
warn diagnostic icon
Type: null or (submodule)
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.warn.enable
Enable the warn diagnostic symbol
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.diagnostics.warn.icon
warn diagnostic symbol
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.filetype.enable
Show the filetype icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.filetype.customColors
Sets the icon’s highlight group. If false, will use nvim-web-devicons colors
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.pinned.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.separator.left
Left seperator
default: ▎
Type: null or string
Default: null
Declared by:
plugins.barbar.icons.visible.separator.right
Right seperator
default: ``
Type: null or string
Default: null
Declared by:
plugins.barbar.insertAtEnd
If true, new buffers will be inserted at the end of the list. Default is to insert after current buffer.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.insertAtStart
If true, new buffers will be inserted at the start of the list. Default is to insert after current buffer.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.barbar.keymaps.close
Keymap for function BufferClose
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo1
Keymap for function BufferGoTo 1
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo2
Keymap for function BufferGoTo 2
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo3
Keymap for function BufferGoTo 3
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo4
Keymap for function BufferGoTo 4
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo5
Keymap for function BufferGoTo 5
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo6
Keymap for function BufferGoTo 6
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo7
Keymap for function BufferGoTo 7
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo8
Keymap for function BufferGoTo 8
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.goTo9
Keymap for function BufferGoTo 9
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.last
Keymap for function BufferLast
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.moveNext
Keymap for function BufferMoveNext
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.movePrevious
Keymap for function BufferMovePrevious
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.next
Keymap for function BufferNext
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.orderByBufferNumber
Keymap for function BufferOrderByBufferNumber
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.orderByDirectory
Keymap for function BufferOrderByDirectory
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.orderByLanguage
Keymap for function BufferOrderByLanguage
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.orderByWindowNumber
Keymap for function BufferOrderByWindowNumber
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.pick
Keymap for function BufferPick
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.pin
Keymap for function BufferPin
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.previous
Keymap for function BufferPrevious
Type: null or string
Default: null
Declared by:
plugins.barbar.keymaps.silent
Whether to enable silent keymaps for barbar.
Type: boolean
Default: false
Example: true
Declared by:
plugins.barbar.letters
New buffer letters are assigned in this order. This order is optimal for the qwerty keyboard layout but might need adjustement for other layouts.
default: asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP
Type: null or string
Default: null
Declared by:
plugins.barbar.maximumLength
Sets the maximum buffer name length.
default: 30
Type: null or signed integer
Default: null
Declared by:
plugins.barbar.maximumPadding
Sets the maximum padding width with which to surround each tab
default: 4
Type: null or signed integer
Default: null
Declared by:
plugins.barbar.minimumPadding
Sets the minimum padding width with which to surround each tab
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.barbar.noNameTitle
Sets the name of unnamed buffers. By default format is “[Buffer X]” where X is the buffer number. But only a static string is accepted here.
Type: null or string
Default: null
Declared by:
plugins.barbar.semanticLetters
If set, the letters for each buffer in buffer-pick mode will be assigned based on their name. Otherwise or in case all letters are already assigned, the behavior is to assign letters in order of usability (see letters option)
default: true
Type: null or boolean
Default: null
Declared by:
plugins.barbar.sidebarFiletypes
Set the filetypes which barbar will offset itself for
Type: null or (attribute set of (value true (singular enum) or (submodule)))
Default: null
Declared by:
plugins.barbar.tabpages
Enable/disable current/total tabpages indicator (top right corner).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.enable
Whether to enable bufferline.
Type: boolean
Default: false
Example: true
Declared by:
plugins.bufferline.package
Plugin to use for bufferline
Type: package
Default: <derivation vimplugin-bufferline.nvim-2023-06-28>
Declared by:
plugins.bufferline.alwaysShowBufferline
Whether to always show the bufferline.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.bufferCloseIcon
The close icon for each buffer.
default:
Type: null or string
Default: null
Declared by:
plugins.bufferline.closeCommand
Command or function run when closing a buffer.
default: bdelete! %d
Type: null or string
Default: null
Declared by:
plugins.bufferline.closeIcon
The close icon.
default:
Type: null or string
Default: null
Declared by:
plugins.bufferline.colorIcons
Enable color icons.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.customFilter
fun(buf: number, bufnums: number[]): boolean
default: null
Type: null or string
Default: null
Declared by:
plugins.bufferline.debug
Debug options
Type: null or (submodule)
Default: null
Declared by:
plugins.bufferline.debug.logging
Whether to enable logging
default: false
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.diagnostics
diagnostics
default: false
Type: null or boolean or one of “nvim_lsp”, “coc”
Default: null
Declared by:
plugins.bufferline.diagnosticsIndicator
Either null or a function that returns the diagnistics indicator.
default: null
Type: null or string
Default: null
Declared by:
plugins.bufferline.diagnosticsUpdateInInsert
Whether diagnostics should update in insert mode
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.enforceRegularTabs
Whether to enforce regular tabs.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.bufferline.getElementIcon
Lua function returning an element icon.
fun(opts: IconFetcherOpts): string?, string?
default: null
Type: null or string
Default: null
Declared by:
plugins.bufferline.groups
groups
Type: null or (submodule)
Default: null
Declared by:
plugins.bufferline.groups.items
List of groups.
default: []
Type: null or (list of (attribute set))
Default: null
Declared by:
plugins.bufferline.groups.options
Group options
Type: null or (submodule)
Default: null
Declared by:
plugins.bufferline.groups.options.toggleHiddenOnEnter
Re-open hidden groups on bufenter.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.background.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.background.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.background.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.background.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.background.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.bufferSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.bufferSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.bufferVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.bufferVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.bufferVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButton.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButton.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButton.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButton.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButton.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.closeButtonVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnostic.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnostic.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnostic.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnostic.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnostic.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.diagnosticVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicate.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicate.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicate.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicate.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicate.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicateSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicateSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicateVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.duplicateVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.duplicateVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.error.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.error.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.error.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.error.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.error.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnostic.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnostic.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnostic.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnostic.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnostic.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorDiagnosticVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.errorVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.errorVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.fill.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.fill.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.fill.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.fill.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.fill.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.indicatorSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.indicatorSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.indicatorSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.indicatorSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.indicatorSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.info.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.info.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.info.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.info.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.info.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnostic.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnostic.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnostic.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnostic.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnostic.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoDiagnosticVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.infoVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.infoVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modified.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modified.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modified.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modified.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modified.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modifiedSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modifiedSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modifiedVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.modifiedVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.modifiedVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pick.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pick.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pick.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pick.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pick.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pickSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pickSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pickVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.pickVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.pickVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separator.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separator.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separator.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separator.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separator.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separatorSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separatorSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separatorVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.separatorVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.separatorVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tab.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tab.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tab.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tab.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tab.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabClose.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabClose.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tabClose.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabClose.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tabClose.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tabSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.tabSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.tabSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warning.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warning.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warning.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warning.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warning.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnostic.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnostic.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnostic.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnostic.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnostic.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningDiagnosticVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningSelected.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningSelected.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningSelected.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningSelected.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningSelected.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningVisible.bg
background color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningVisible.bold
enable bold
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningVisible.fg
foreground color
Type: null or string
Default: null
Declared by:
plugins.bufferline.highlights.warningVisible.italic
enable italic
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.highlights.warningVisible.sp
sp color
Type: null or string
Default: null
Declared by:
plugins.bufferline.hover
Hover
Type: null or (submodule)
Default: null
Declared by:
plugins.bufferline.hover.enabled
Whether to enable hover.
Type: boolean
Default: false
Example: true
Declared by:
plugins.bufferline.hover.delay
delay
default: 200
Type: null or signed integer
Default: null
Declared by:
plugins.bufferline.hover.reveal
reveal
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.bufferline.indicator.icon
icon
default: ▎
Type: null or string
Default: null
Declared by:
plugins.bufferline.indicator.style
style
default: "icon"
Type: null or one of “icon”, “underline”
Default: null
Declared by:
plugins.bufferline.leftMouseCommand
Command or function run when clicking on a buffer.
default: buffer %d
Type: null or string
Default: null
Declared by:
plugins.bufferline.leftTruncMarker
left trunc marker
default:
Type: null or string
Default: null
Declared by:
plugins.bufferline.maxNameLength
Max length of a buffer name.
default: 18
Type: null or signed integer
Default: null
Declared by:
plugins.bufferline.maxPrefixLength
Maximum prefix length
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.bufferline.middleMouseCommand
Command or function run when middle clicking on a buffer.
default: null
Type: null or string
Default: null
Declared by:
plugins.bufferline.mode
mode
default: "buffers"
Type: null or one of “buffers”, “tabs”
Default: null
Declared by:
plugins.bufferline.modifiedIcon
The icon indicating a buffer was modified.
default: ●
Type: null or string
Default: null
Declared by:
plugins.bufferline.nameFormatter
A lua function that can be used to modify the buffer’s label. The argument ‘buf’ containing a name, path and bufnr is supplied.
default: null
Type: null or string
Default: null
Declared by:
plugins.bufferline.numbers
Customize the styling of numbers.
Either one of “none” “ordinal” “buffer_id” “both” or a lua function:
function({ ordinal, id, lower, raise }): string
default: none
Type: null or one of “none”, “ordinal”, “buffer_id”, “both” or (submodule)
Default: null
Declared by:
plugins.bufferline.offsets
offsets
default: null
Type: null or (list of (attribute set))
Default: null
Declared by:
plugins.bufferline.persistBufferSort
Whether to make the buffer sort persistent.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.rightMouseCommand
Command or function run when right clicking on a buffer.
default: bdelete! %d
Type: null or string
Default: null
Declared by:
plugins.bufferline.rightTruncMarker
right trunc marker
default:
Type: null or string
Default: null
Declared by:
plugins.bufferline.separatorStyle
Separator style
default: "thin"
Type: null or one of “slant”, “padded_slant”, “slope”, “padded_slope”, “thick”, “thin”
Default: null
Declared by:
plugins.bufferline.showBufferCloseIcons
Show buffer close icons
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.showBufferIcons
Show buffer icons
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.showCloseIcon
Whether to show the close icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.showDuplicatePrefix
Whether to show the prefix of duplicated files.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.showTabIndicators
Whether to show the tab indicators.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.sortBy
sort by
default: id
Type: null or string
Default: null
Declared by:
plugins.bufferline.tabSize
Size of the tabs
default: 18
Type: null or signed integer
Default: null
Declared by:
plugins.bufferline.themable
Whether or not bufferline highlights can be overridden externally
default: true
Type: null or boolean
Default: null
Declared by:
plugins.bufferline.truncateNames
Whether to truncate names.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.chadtree.enable
Whether to enable chadtree.
Type: boolean
Default: false
Example: true
Declared by:
plugins.chadtree.package
Plugin to use for chadtree
Type: package
Default: <derivation vimplugin-chadtree-2023-07-09>
Declared by:
plugins.chadtree.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.chadtree.keymap.bookmarks.bookmarkGoto
Goto bookmark A-Z.
default: ["m"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.copyBasename
Copy names of files under cursor or visual block.
default: ["Y"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.copyName
Copy paths of files under cursor or visual block.
default: ["y"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.copyRelname
Copy relative paths of files under cursor or visual block.
default: ["<c-y>"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.jumpToCurrent
Position cursor in CHADTree at currently open buffer, if the buffer points to a location visible under CHADTree.
default: ["J"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.refocus
Put cursor at the root of CHADTree.
default: ["~"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.cursor.stat
Print ls --long stat for file under cursor.
default: ["K"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.copy
Copy the selected files to location under cursor.
default: ["p"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.cut
Move the selected files to location under cursor.
default: ["x"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.delete
Delete the selected files. Items deleted cannot be recovered.
default: ["d"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.link
Create links at location under cursor from selection.
Links are always relative.
Intermediary folders are created automatically.
default: ["A"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.new
Create new file at location under cursor. Files ending with platform specific path separator will be folders.
Intermediary folders are created automatically.
ie. uwu/owo/ under unix will create uwu/ then owo/ under it. Both are folders.
default: ["a"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.rename
Rename file under cursor.
default: ["r"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.toggleExec
Toggle all the +x bits of the selected / highlighted files.
Except for directories, where -x will prevent reading.
default: ["X"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.fileOperations.trash
Trash the selected files using platform specific trash command, if they are available. Items trashed may be recovered.
default: [t]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.filtering.clearFilter
Clear filter.
default: ["F"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.filtering.filter
Set a glob pattern to narrow down visible files.
default: ["f"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.collapse
Collapse all subdirectories for directory at cursor.
default: ["o"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.hSplit
Open file at cursor in horizontal split.
default: ["W"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.openSys
Open file with GUI tools using open or xdg open. This will open third party tools such as Finder or KDE Dolphin or GNOME nautilus, etc. Depends on platform and user setup.
default: ["o"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.primary
Open file at cursor.
default: ["<enter>"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.secondary
Open file at cursor, keep cursor in CHADTree’s window.
default: ["<tab> <2-leftmouse>"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.tertiary
Open file at cursor in a new tab.
default: ["<m-enter>" <middlemouse>]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.openFileFolder.vSplit
Open file at cursor in vertical split.
default: ["w"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.rerooting.changeDir
Change vim’s working directory.
default: ["b"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.rerooting.changeFocus
Set CHADTree’s root to folder at cursor. Does not change working directory.
default: ["c"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.rerooting.changeFocusUp
Set CHADTree’s root one level up.
default: ["C"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.selecting.clearSelection
Clear selection.
default: ["S"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.selecting.select
Select files under cursor or visual block.
default: ["s"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.toggles.toggleFollow
Toggle follow on and off. See chadtree.follow for details.
default: ["u"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.toggles.toggleHidden
Toggle show_hidden on and off. See chadtree.showHidden for details.
default: ["."]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.toggles.toggleVersionControl
Toggle version control integration on and off.
default: ["i"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.windowManagement.bigger
Resize CHADTree window bigger.
default: ["+" "="]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.windowManagement.quit
Close CHADTree window, quit if it is the last window.
default: ["q"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.windowManagement.refresh
Refresh CHADTree.
default: ["<c-r>"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.keymap.windowManagement.smaller
Resize CHADTree window smaller.
default: ["-" "_"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.follow
CHADTree will highlight currently open file, and open all its parents.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.chadtree.options.ignore.nameExact
Files whose name match these exactly will be ignored.
default: [".DS_Store" ".directory" "thumbs.db" ".git"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.ignore.nameGlob
Files whose name match these glob patterns will be ignored. ie. *.py will match all python files
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.ignore.pathGlob
Files whose full path match these glob patterns will be ignored.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.lang
CHADTree will guess your locale from unix environmental variables. Set to c to disable emojis.
Type: null or string
Default: null
Declared by:
plugins.chadtree.options.mimetypes.allowExts
Skip warning for these extensions.
default: [".ts"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.mimetypes.warn
Show a warning before opening these datatypes.
default: ["audio" "font" "image" "video"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.options.pageIncrement
Change how many lines { and } scroll.
default: 5
Type: null or signed integer
Default: null
Declared by:
plugins.chadtree.options.pollingRate
CHADTree’s background refresh rate.
default: 2.000000
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.chadtree.options.session
Save & restore currently open folders.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.chadtree.options.showHidden
Hide some files and folders by default. By default this can be toggled using the . key. see chadtree_settings.ignore for more details.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.chadtree.options.versionControl
Enable version control. This can also be toggled. But unlike show_hidden, does not have a default keybind.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.chadtree.theme.highlights.bookmarks
These are used to show bookmarks.
default: Title
Type: null or string
Default: null
Declared by:
plugins.chadtree.theme.highlights.ignored
These are used for files that are ignored by user supplied pattern in chadtree.ignore and by version control.
default: Comment
Type: null or string
Default: null
Declared by:
plugins.chadtree.theme.highlights.quickfix
These are used to notify the number of times a file / folder appears in the quickfix list.
default: Label
Type: null or string
Default: null
Declared by:
plugins.chadtree.theme.highlights.versionControl
These are used to put a version control status beside each file.
default: Comment
Type: null or string
Default: null
Declared by:
plugins.chadtree.theme.iconColourSet
Right now you all the file icons are coloured according to Github colours.
You may also disable colouring if you wish.
default: "github"
Type: null or one of “github”, “none”
Default: null
Declared by:
plugins.chadtree.theme.iconGlyphSet
Icon glyph set to use.
default: "devicons"
Type: null or one of “devicons”, “emoji”, “ascii”, “ascii_hollow”
Default: null
Declared by:
plugins.chadtree.theme.textColourSet
On unix, the command ls can produce coloured results based on the LS_COLORS environmental variable.
CHADTree can pretend it’s ls by setting chadtree.theme.textColourSet to env.
If you are not happy with that, you can choose one of the many others.
default: "env"
Type: null or one of “env”, “solarized_dark_256”, “solarized_dark”, “solarized_light”, “solarized_universal”, “nord”, “trapdoor”, “nerdtree_syntax_light”, “nerdtree_syntax_dark”
Default: null
Declared by:
plugins.chadtree.view.openDirection
Which way does CHADTree open?
default: "left"
Type: null or one of “left”, “right”
Default: null
Declared by:
plugins.chadtree.view.sortBy
CHADTree can sort by the following criterion. Reorder them if you want a different sorting order. legal keys: some of ["is_folder" "ext" "file_name"]
default: ["is_folder" "ext" "file_name"]
Type: null or (list of string)
Default: null
Declared by:
plugins.chadtree.view.width
How big is CHADTree when initially opened?
default: 40
Type: null or signed integer
Default: null
Declared by:
plugins.chadtree.view.windowOptions
Set of window local options to for CHADTree windows.
default: { cursorline = true; number = false; relativenumber = false; signcolumn = "no"; winfixwidth = true; wrap = false; }
Type: null or (attribute set)
Default: null
Declared by:
plugins.clangd-extensions.enable
Whether to enable clangd_extensions, plugin implementing clangd LSP extensions.
Type: boolean
Default: false
Example: true
Declared by:
plugins.clangd-extensions.enableOffsetEncodingWorkaround
Whether to enable utf-16 offset encoding. This is used to work around the warning: “multiple different client offset_encodings detected for buffer, this is not supported yet” .
Type: boolean
Default: false
Example: true
Declared by:
plugins.clangd-extensions.package
Plugin to use for clangd_extensions.nvim
Type: package
Default: <derivation vimplugin-clangd_extensions.nvim-2023-05-23>
Declared by:
plugins.clangd-extensions.extensions.ast.highlights.detail
default: Comment
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.compound
default: 🄲
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.packExpansion
default: 🄿
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.recovery
default: 🅁
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.templateParamObject
default: 🅃
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.templateTemplateParm
default: 🅃
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.templateTypeParm
default: 🅃
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.kindIcons.translationUnit
default: 🅄
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.declaration
default: 🄓
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.expression
default: 🄔
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.specifier
default: 🄢
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.statement
default: ;
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.templateArgument
default: 🆃
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.ast.roleIcons.type
default: 🄣
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.autoSetHints
Automatically set inlay hints (type hints)
default: true
Type: null or boolean
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.highlight
The color of the hints
default: Comment
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.maxLenAlign
whether to align to the length of the longest line in the file
default: false
Type: null or boolean
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.maxLenAlignPadding
padding from the left if max_len_align is true
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.onlyCurrentLine
Only show inlay hints for the current line
default: false
Type: null or boolean
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.onlyCurrentLineAutocmd
Event which triggers a refersh of the inlay hints. You can make this “CursorMoved” or “CursorMoved,CursorMovedI” but not that this may cause higher CPU usage. This option is only respected when only_current_line and autoSetHints both are true.
default: CursorHold
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.otherHintsPrefix
prefix for all the other hints (type, chaining)
default: =>
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.parameterHintsPrefix
prefix for parameter hints
default: <-
Type: null or string
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.priority
The highlight group priority for extmark
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.rightAlign
whether to align to the extreme right or not
default: false
Type: null or boolean
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.rightAlignPadding
padding from the right if right_align is true
default: 7
Type: null or signed integer
Default: null
Declared by:
plugins.clangd-extensions.extensions.inlayHints.showParameterHints
whether to show parameter hints with the inlay hints or not
default: true
Type: null or boolean
Default: null
Declared by:
plugins.clangd-extensions.extensions.memoryUsage.border
Defines the border to use for clangd-extensions. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: none
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.clangd-extensions.extensions.symbolInfo.border
Defines the border to use for clangd-extensions. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: none
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.clangd-extensions.server.package
Package to use for clangd
Type: package
Default: <derivation clang-tools-14.0.6>
Declared by:
plugins.clangd-extensions.server.extraOptions
Extra options to pass to nvim-lspconfig. You should not need to use this directly
Type: attribute set of anything
Default: { }
Declared by:
plugins.cmp-buffer.enable
Whether to enable Enable cmp-buffer.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-calc.enable
Whether to enable Enable cmp-calc.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-clippy.enable
Whether to enable Enable cmp-clippy.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-cmdline.enable
Whether to enable Enable cmp-cmdline.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-cmdline-history.enable
Whether to enable Enable cmp-cmdline-history.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-conventionalcommits.enable
Whether to enable Enable cmp-conventionalcommits.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-dap.enable
Whether to enable Enable cmp-dap.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-dictionary.enable
Whether to enable Enable cmp-dictionary.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-digraphs.enable
Whether to enable Enable cmp-digraphs.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-emoji.enable
Whether to enable Enable cmp-emoji.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-fish.enable
Whether to enable Enable cmp-fish.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-fuzzy-buffer.enable
Whether to enable Enable cmp-fuzzy-buffer.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-fuzzy-path.enable
Whether to enable Enable cmp-fuzzy-path.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-git.enable
Whether to enable Enable cmp-git.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-greek.enable
Whether to enable Enable cmp-greek.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-latex-symbols.enable
Whether to enable Enable cmp-latex-symbols.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-look.enable
Whether to enable Enable cmp-look.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-npm.enable
Whether to enable Enable cmp-npm.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-nvim-lsp.enable
Whether to enable Enable cmp-nvim-lsp.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-nvim-lsp-document-symbol.enable
Whether to enable Enable cmp-nvim-lsp-document-symbol.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-nvim-lsp-signature-help.enable
Whether to enable Enable cmp-nvim-lsp-signature-help.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-nvim-lua.enable
Whether to enable Enable cmp-nvim-lua.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-nvim-ultisnips.enable
Whether to enable Enable cmp-nvim-ultisnips.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-omni.enable
Whether to enable Enable cmp-omni.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-pandoc-nvim.enable
Whether to enable Enable cmp-pandoc-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-pandoc-references.enable
Whether to enable Enable cmp-pandoc-references.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-path.enable
Whether to enable Enable cmp-path.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-rg.enable
Whether to enable Enable cmp-rg.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-snippy.enable
Whether to enable Enable cmp-snippy.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-spell.enable
Whether to enable Enable cmp-spell.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-tabnine.enable
Whether to enable Enable cmp-tabnine.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-tabnine.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.cmp-tmux.enable
Whether to enable Enable cmp-tmux.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-treesitter.enable
Whether to enable Enable cmp-treesitter.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-vim-lsp.enable
Whether to enable Enable cmp-vim-lsp.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-vimwiki-tags.enable
Whether to enable Enable cmp-vimwiki-tags.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-vsnip.enable
Whether to enable Enable cmp-vsnip.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp-zsh.enable
Whether to enable Enable cmp-zsh.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cmp_luasnip.enable
Whether to enable Enable cmp_luasnip.
Type: boolean
Default: false
Example: true
Declared by:
plugins.comment-nvim.enable
Whether to enable Enable comment-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.comment-nvim.package
Plugin to use for comment-nvim
Type: package
Default: <derivation vimplugin-comment.nvim-2023-06-12>
Declared by:
plugins.comment-nvim.ignore
Lines to be ignored while comment/uncomment
Type: null or string
Default: null
Declared by:
plugins.comment-nvim.mappings
Create basic (operator-pending) and extended mappings for NORMAL + VISUAL mode
Type: null or (submodule)
Default: null
Declared by:
plugins.comment-nvim.mappings.basic
operator-pending mapping. Includes ‘gcc’, ‘gcb’, ‘gc[count]{motion}’ and ‘gb[count]{motion}’
Type: boolean
Default: true
Declared by:
plugins.comment-nvim.mappings.extended
extended mapping. Includes ‘g>’, ‘g<’, ‘g>[count]{motion}’ and ‘g<[count]{motion}’
Type: boolean
Default: false
Declared by:
plugins.comment-nvim.mappings.extra
extra mapping. Includes ‘gco’, ‘gc0’, ‘gcA’
Type: boolean
Default: true
Declared by:
plugins.comment-nvim.opleader
LHS of operator-pending mappings in NORMAL + VISUAL mode
Type: null or (submodule)
Default: null
Declared by:
plugins.comment-nvim.opleader.block
block-comment keymap
Type: string
Default: "gb"
Declared by:
plugins.comment-nvim.opleader.line
line-comment keymap
Type: string
Default: "gc"
Declared by:
plugins.comment-nvim.padding
Add a space b/w comment and the line
Type: null or boolean
Default: null
Declared by:
plugins.comment-nvim.sticky
Whether the cursor should stay at its position
Type: null or boolean
Default: null
Declared by:
plugins.comment-nvim.toggler
LHS of toggle mappings in NORMAL + VISUAL mode
Type: null or (submodule)
Default: null
Declared by:
plugins.comment-nvim.toggler.block
block-comment keymap
Type: string
Default: "gbc"
Declared by:
plugins.comment-nvim.toggler.line
line-comment keymap
Type: string
Default: "gcc"
Declared by:
plugins.commentary.enable
Whether to enable commentary.
Type: boolean
Default: false
Example: true
Declared by:
plugins.commentary.package
Plugin to use for commentary
Type: package
Default: <derivation vimplugin-vim-commentary-2022-10-31>
Declared by:
plugins.conjure.enable
Whether to enable Conjure.
Type: boolean
Default: false
Example: true
Declared by:
plugins.conjure.package
Plugin to use for conjure
Type: package
Default: <derivation vimplugin-conjure-2023-06-11>
Declared by:
plugins.copilot-cmp.enable
Whether to enable Enable copilot-cmp.
Type: boolean
Default: false
Example: true
Declared by:
plugins.copilot-cmp.event
Configures when the source is registered. Unless you have a unique problem for your particular configuration you probably don’t want to touch this.
default: ["InsertEnter" "LspAttach"]
Type: null or (list of string)
Default: null
Declared by:
plugins.copilot-cmp.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.copilot-cmp.fixPairs
Suppose you have the following code: print('h'). Copilot might try to account for the ' and ) and complete it with this: print('hello.
This is not good behavior for consistency reasons and will just end up deleting the two ending characters. This option fixes that. Don’t turn this off unless you are having problems with pairs and believe this might be causing them.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.copilot-lua.enable
Whether to enable copilot.lua.
Type: boolean
Default: false
Example: true
Declared by:
plugins.copilot-lua.package
Plugin to use for copilot.lua
Type: package
Default: <derivation vimplugin-copilot.lua-2023-07-01>
Declared by:
plugins.copilot-lua.copilotNodeCommand
Use this field to provide the path to a specific node version such as one installed by nvm. Node.js version must be 16.x or newer.
Type: string
Default: "/nix/store/l43bdmxxlkrzwic3q24ik366qyqg3s1g-nodejs-18.16.1/bin/node"
Declared by:
plugins.copilot-lua.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.copilot-lua.filetypes
Specify filetypes for attaching copilot. Each value can be either a boolean or a lua function that returns a boolean.
Example:
{
markdown = true; # overrides default
terraform = false; # disallow specific filetype
sh.__raw = \'\'
function ()
if string.match(vim.fs.basename(vim.api.nvim_buf_get_name(0)), '^%.env.*') then
-- disable for .env files
return false
end
return true
end
\'\';
}
The key "*" can be used to disable the default configuration. Example:
{
javascript = true; # allow specific filetype
typescript = true; # allow specific filetype
"*" = false; # disable for all other filetypes and ignore default `filetypes`
}
default: { yaml = false; markdown = false; help = false; gitcommit = false; gitrebase = false; hgcommit = false; svn = false; cvs = false; "." = false; }
Type: null or (attribute set of (boolean or (submodule)))
Default: null
Declared by:
plugins.copilot-lua.panel.enabled
Enable the panel.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.copilot-lua.panel.autoRefresh
Enable auto-refresh.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.copilot-lua.panel.keymap.accept
Keymap to accept the proposed suggestion.
default: <CR>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.panel.keymap.jumpNext
Keymap for jumping to the next suggestion.
default: ]]
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.panel.keymap.jumpPrev
Keymap for jumping to the previous suggestion.
default: [[
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.panel.keymap.open
Keymap to open.
default: <M-CR>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.panel.keymap.refresh
Keymap to refresh the suggestions.
default: gr
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.panel.layout.position
The panel position.
default: "bottom"
Type: null or one of “bottom”, “top”, “left”, “right”
Default: null
Declared by:
plugins.copilot-lua.panel.layout.ratio
The panel ratio.
default: 0.4
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.copilot-lua.serverOptsOverrides
Override copilot lsp client settings. The settings field is where you can set the values of the options defined in https://github.com/zbirenbaum/copilot.lua/blob/master/SettingsOpts.md;. These options are specific to the copilot lsp and can be used to customize its behavior.
Ensure that the name field is not overriden as is is used for efficiency reasons in numerous checks to verify copilot is actually running.
See :h vim.lsp.start_client for list of options.
Example:
{
trace = "verbose";
settings = {
advanced = {
listCount = 10; # number of completions for panel
inlineSuggestCount = 3; # number of completions for getCompletions
};
};
}
default: {}
Type: null or (attribute set)
Default: null
Declared by:
plugins.copilot-lua.suggestion.enabled
Enable suggestion.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.copilot-lua.suggestion.autoTrigger
Enable auto-trigger.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.copilot-lua.suggestion.debounce
Debounce.
default: 75
Type: null or signed integer
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.accept
Keymap for accepting the suggestion.
default: <M-l>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.acceptLine
Keymap for accepting a line suggestion.
default: false
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.acceptWord
Keymap for accepting a word suggestion.
default: false
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.dismiss
Keymap to dismiss the suggestion.
default: <C-]>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.next
Keymap for accepting the next suggestion.
default: <M-]>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-lua.suggestion.keymap.prev
Keymap for accepting the previous suggestion.
default: <M-[>
Type: null or value false (singular enum) or string
Default: null
Declared by:
plugins.copilot-vim.enable
Whether to enable copilot.vim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.copilot-vim.package
Plugin to use for copilot.vim
Type: package
Default: <derivation vimplugin-copilot.vim-2023-06-30>
Declared by:
plugins.copilot-vim.extraConfig
The configuration options for copilot without the ‘copilot_’ prefix. Example: To set ‘copilot_foo_bar’ to 1, write extraConfig = { foo_bar = true; };
Type: attribute set
Default: { }
Declared by:
plugins.copilot-vim.filetypes
A dictionary mapping file types to their enabled status
Type: attribute set of boolean
Default: { }
Example:
{
"*" = false;
python = true;
}
Declared by:
plugins.copilot-vim.proxy
Tell Copilot what proxy server to use. Example: “localhost:3128”
default: ``
Type: null or string
Default: null
Declared by:
plugins.coq-nvim.enable
Whether to enable coq-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.coq-nvim.package
Plugin to use for coq-nvim
Type: package
Default: <derivation vimplugin-coq_nvim-2023-07-09>
Declared by:
plugins.coq-nvim.autoStart
Auto-start or shut up
Type: null or boolean or value “shut-up” (singular enum)
Default: null
Declared by:
plugins.coq-nvim.installArtifacts
Whether to enable Install coq-artifacts.
Type: boolean
Default: false
Example: true
Declared by:
plugins.coq-nvim.recommendedKeymaps
Use the recommended keymaps
Type: null or boolean
Default: null
Declared by:
plugins.coq-thirdparty.enable
Whether to enable coq-thirdparty.
Type: boolean
Default: false
Example: true
Declared by:
plugins.coq-thirdparty.package
Plugin to use for coq-thirdparty
Type: package
Default: <derivation vimplugin-coq.thirdparty-2023-07-09>
Declared by:
plugins.coq-thirdparty.sources
List of sources
Type: list of (attribute set)
Default: [ ]
Example:
[
{
shortName = "nLUA";
src = "nvimlua";
}
{
shortName = "vTEX";
src = "vimtex";
}
{
acceptKey = "<c-f>";
shortName = "COP";
src = "copilot";
}
{
src = "demo";
}
]
Declared by:
plugins.coq-thirdparty.sources.*.short_name
A short name for the source. If not specified, it is uppercase src.
Type: null or string
Default: null
Example: "nLUA"
Declared by:
plugins.coq-thirdparty.sources.*.src
The name of the source
Type: string
Declared by:
plugins.coverage.enable
Whether to enable nvim-coverage.
Type: boolean
Default: false
Example: true
Declared by:
plugins.coverage.package
Plugin to use for nvim-coverage
Type: package
Default: <derivation vimplugin-nvim-coverage-2023-05-26>
Declared by:
plugins.coverage.autoReload
If true, the coverage_file for a langauge will be watched for changes after executing :CoverageLoad or coverage.load(). The file watcher will be stopped after executing :CoverageClear or coverage.clear().
default: false
Type: null or boolean
Default: null
Declared by:
plugins.coverage.autoReloadTimeoutMs
The number of milliseconds to wait before auto-reloading coverage after detecting a change.
default: 500
Type: null or signed integer
Default: null
Declared by:
plugins.coverage.commands
If true, create commands.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.coverage.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.coverage.highlights.covered
Highlight group for covered signs.
default: {fg = "#B7F071";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.partial
Highlight group for partial coverage signs.
default: {fg = "#AA71F0";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryBorder
Border highlight group of the summary pop-up.
default: {link = "FloatBorder";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryCursorLine
Cursor line highlight group of the summary pop-up.
default: {link = "CursorLine";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryFail
Fail text highlight group of the summary pop-up.
default: {link = "CoverageUncovered";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryHeader
Header text highlight group of the summary pop-up.
default: { style = "bold,underline"; sp = "bg"; }
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryNormal
Normal text highlight group of the summary pop-up.
default: {link = "NormalFloat";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.summaryPass
Pass text highlight group of the summary pop-up.
default: {link = "CoverageCovered";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.highlights.uncovered
Highlight group for uncovered signs.
default: {fg = "#F07178";}
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.keymaps.clear
Unloads the cached coverage signs. :Coverage or :CoverageLoad must be called again to relad the data.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.coverage
Loads a coverage report and immediately displays the coverage signs.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.hide
Hides the coverage signs. Must call :Coverage or :CoverageLoad first.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.load
Loads a coverage report but does not display the coverage signs.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.show
Shows the coverage signs. Must call :Coverage or :CoverageLoad first.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.summary
Displays a coverage summary report in a floating window.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymaps.toggle
Toggles the coverage signs. Must call :Coverage or :CoverageLoad first.
Type: null or string
Default: null
Declared by:
plugins.coverage.keymapsSilent
Whether nvim-coverage keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.coverage.lang
Each key corresponds with the filetype of the language and maps to an attrs of configuration values that differ. See plugin documentation for language specific options.
Example:
{
python = {
coverage_file = ".coverage";
coverage_command = "coverage json --fail-under=0 -q -o -";
};
ruby = {
coverage_file = "coverage/coverage.json";
};
}
default: see upstream documentation
Type: null or (attribute set)
Default: null
Declared by:
plugins.coverage.lcovFile
File that the plugin will try to read lcov coverage from.
Type: null or string
Default: null
Declared by:
plugins.coverage.loadCoverageCb
A lua function that will be called when a coverage file is loaded.
Example:
function (ftype)
vim.notify("Loaded " .. ftype .. " coverage")
end
Type: null or string
Default: null
Declared by:
plugins.coverage.signGroup
Name of the sign group used when placing the signs. See :h sign-group.
default: coverage
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.covered.hl
The highlight group used for covered signs.
default: CoverageCovered
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.covered.text
The text used for covered signs.
default: ▎
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.partial.hl
The highlight group used for partial coverage signs.
default: CoveragePartial
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.partial.text
The text used for partial coverage signs.
default: ▎
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.uncovered.hl
The highlight group used for uncovered signs.
default: CoverageUncovered
Type: null or string
Default: null
Declared by:
plugins.coverage.signs.uncovered.text
The text used for uncovered signs.
default: ▎
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.bot
default: ─
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.botleft
default: ╰
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.botright
default: ╯
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.highlight
default: Normal:CoverageSummaryBorder
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.left
default: │
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.right
default: │
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.top
default: ─
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.topleft
default: ╭
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.borders.topright
default: ╮
Type: null or string
Default: null
Declared by:
plugins.coverage.summary.heightPercentage
Height of the pop-up window.
default: 0.50
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.coverage.summary.minCoverage
Minimum coverage percentage. Values below this are highlighted with the fail group, values above are highlighted with the pass group.
default: 80
Type: null or integer or floating point number between 0 and 100 (both inclusive)
Default: null
Declared by:
plugins.coverage.summary.widthPercentage
Width of the pop-up window.
default: 0.70
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.crates-nvim.enable
Whether to enable Enable crates-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.crates-nvim.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.cursorline.enable
Whether to enable nvim-cursorline.
Type: boolean
Default: false
Example: true
Declared by:
plugins.cursorline.package
Plugin to use for nvim-cursorline
Type: package
Default: <derivation vimplugin-nvim-cursorline-2022-04-15>
Declared by:
plugins.cursorline.cursorline.enable
Show / hide cursorline in connection with cursor moving.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.cursorline.cursorline.number
Whether to also highlight the line number.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.cursorline.cursorline.timeout
Time (in ms) after which the cursorline appears.
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.cursorline.cursorword.enable
Underlines the word under the cursor.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.cursorline.cursorword.hl
Highliht definition map for cursorword highlighting.
default: {underline = true;}
Type: null or (attribute set)
Default: null
Declared by:
plugins.cursorline.cursorword.minLength
Minimum length for underlined words.
default: 3
Type: null or signed integer
Default: null
Declared by:
plugins.cursorline.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.dap.enable
Whether to enable dap.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dap.package
Plugin to use for dap
Type: package
Default: <derivation vimplugin-nvim-dap-2023-07-09>
Declared by:
plugins.dap.adapters
Dap adapters.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.adapters.executables
Debug adapters of executable type. The adapters can also be set to a function which takes three arguments:
-
A
on_configcallback. This must be called with the actual adapter table. -
The |dap-configuration| which the user wants to use.
-
An optional parent session. This is only available if the debug-adapter wants to start a child-session via a
startDebuggingrequest.
This can be used to defer the resolving of the values to when a configuration is used. A use-case for this is starting an adapter asynchronous.
Type: null or (attribute set of (string or (submodule)))
Default: null
Declared by:
plugins.dap.adapters.servers
Debug adapters of server type. The adapters can also be set to a function which takes three arguments:
-
A
on_configcallback. This must be called with the actual adapter table. -
The |dap-configuration| which the user wants to use.
-
An optional parent session. This is only available if the debug-adapter wants to start a child-session via a
startDebuggingrequest.
This can be used to defer the resolving of the values to when a configuration is used. A use-case for this is starting an adapter asynchronous.
Type: null or (attribute set of (string or (submodule)))
Default: null
Declared by:
plugins.dap.configurations
Debugee configurations, see :h dap-configuration for more info.
Type: null or (attribute set of list of (attribute set))
Default: null
Declared by:
plugins.dap.configurations.<name>.*.name
A user readable name for the configuration.
Type: string
Declared by:
plugins.dap.configurations.<name>.*.request
Indicates whether the debug adapter should launch a debugee or attach to one that is already running.
Type: one of “attach”, “launch”
Declared by:
plugins.dap.configurations.<name>.*.type
Which debug adapter to use.
Type: string
Declared by:
plugins.dap.extensions.dap-go.enable
Whether to enable dap-go.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dap.extensions.dap-go.package
Plugin to use for dap-go
Type: package
Default: <derivation vimplugin-nvim-dap-go-2023-05-23>
Declared by:
plugins.dap.extensions.dap-go.dapConfigurations
Additional dap configurations. See :h dap-configuration for more detail.
Type: null or (list of (attribute set))
Default: null
Declared by:
plugins.dap.extensions.dap-go.dapConfigurations.*.name
A user readable name for the configuration.
Type: string
Declared by:
plugins.dap.extensions.dap-go.dapConfigurations.*.request
Indicates whether the debug adapter should launch a debugee or attach to one that is already running.
Type: one of “attach”, “launch”
Declared by:
plugins.dap.extensions.dap-go.dapConfigurations.*.type
Which debug adapter to use.
Type: string
Declared by:
plugins.dap.extensions.dap-go.delve.args
Additional args to pass to dlv.
Type: null or (list of string)
Default: null
Declared by:
plugins.dap.extensions.dap-go.delve.initializeTimeoutSec
Time to wait for delve to initialize the debug session.
default: 20
Type: null or signed integer
Default: null
Declared by:
plugins.dap.extensions.dap-go.delve.path
The path to the executable dlv which will be used for debugging.
default: dlv
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-go.delve.port
A string that defines the port to start delve debugger. Defaults to string “${port}” which instructs dap to start the process in a random available port.
default: ${port}
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-python.enable
Whether to enable dap-python.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dap.extensions.dap-python.package
Plugin to use for dap-python
Type: package
Default: <derivation vimplugin-nvim-dap-python-2023-05-23>
Declared by:
plugins.dap.extensions.dap-python.adapterPythonPath
Path to the python interpreter. Path must be absolute or in $PATH and needs to have the debugpy package installed.
Type: string
Default: "/nix/store/1r6n7v2wam7gkr18gxccpg7p5ywgw551-python3-3.10.12/bin/python3"
Declared by:
plugins.dap.extensions.dap-python.console
Debugpy console.
default: "integratedTerminal"
Type: null or one of “integratedTerminal”, “internalConsole”, “externalTerminal”
Default: null
Declared by:
plugins.dap.extensions.dap-python.customConfigurations
Custom python configurations for dap.
Type: null or (list of (attribute set))
Default: null
Declared by:
plugins.dap.extensions.dap-python.customConfigurations.*.name
A user readable name for the configuration.
Type: string
Declared by:
plugins.dap.extensions.dap-python.customConfigurations.*.request
Indicates whether the debug adapter should launch a debugee or attach to one that is already running.
Type: one of “attach”, “launch”
Declared by:
plugins.dap.extensions.dap-python.customConfigurations.*.type
Which debug adapter to use.
Type: string
Declared by:
plugins.dap.extensions.dap-python.includeConfigs
Add default configurations.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-python.resolvePython
Function to resolve path to python to use for program or test execution. By default the VIRTUAL_ENV and CONDA_PREFIX environment variables are used if present.
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-python.testRunner
The name of test runner to use by default. The default value is dynamic and depends on pytest.ini or manage.py markers. If neither is found “unittest” is used.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.dap.extensions.dap-python.testRunners
Set to register test runners. Built-in are test runners for unittest, pytest and django. The key is the test runner name, the value a function to generate the module name to run and its arguments. See |dap-python.TestRunner|.
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.enable
Whether to enable dap-ui.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dap.extensions.dap-ui.package
Plugin to use for dap-ui
Type: package
Default: <derivation vimplugin-nvim-dap-ui-2023-05-29>
Declared by:
plugins.dap.extensions.dap-ui.controls
Options for dap-ui controls.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.enabled
Enable controls
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.element
Element to show the controls on.
default: "repl"
Type: null or one of “repl”, “scopes”, “stacks”, “watches”, “breakpoints”, “console”
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.disconnect
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.pause
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.play
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.run_last
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.step_back
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.step_into
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.step_out
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.step_over
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.controls.icons.terminate
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings
Per-element overrides of global mappings.
Type: null or (attribute set of (submodule))
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.edit
Map edit for element mapping overrides
default: e
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.expand
Map expand for element mapping overrides
default: ["<CR>" "<2-LeftMouse>"]
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.open
Map open for element mapping overrides
default: o
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.remove
Map remove for element mapping overrides
default: d
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.repl
Map repl for element mapping overrides
default: r
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.elementMappings.<name>.toggle
Map toggle for element mapping overrides
default: t
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.expandLines
Expand current line to hover window if larger than window size.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-ui.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.dap.extensions.dap-ui.floating.border
Defines the border to use for dap-ui floating window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: single
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.floating.mappings
Keys to trigger actions in elements.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.floating.mappings.close
Map close for dap-ui floating
default: ["<ESC>" "q"]
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.floating.maxHeight
Maximum height of the floating window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.floating.maxWidth
Maximum width of the floating window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.forceBuffers
Prevents other buffers being loaded into dap-ui windows.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-ui.icons.collapsed
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.icons.current_frame
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.icons.expanded
default:
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.layouts
List of layouts for dap-ui.
default: ```` [ { elements = [ { id = “scopes”; size = 0.25; } { id = “breakpoints”; size = 0.25; } { id = “stacks”; size = 0.25; } { id = “watches”; size = 0.25; } ]; position = “left”; size = 40; } { elements = [ { id = “repl”; size = 0.5; } { id = “console”; size = 0.5; } ]; position = “bottom”; size = 10; } ];
`
Type: null or (list of (submodule))
Default: null
Declared by:
plugins.dap.extensions.dap-ui.layouts.*.elements
Elements to display in this layout.
Type: list of (string or (submodule))
Default: [ ]
Declared by:
plugins.dap.extensions.dap-ui.layouts.*.position
Which side of editor to open layout on.
Type: one of “left”, “right”, “top”, “bottom”
Default: "left"
Declared by:
plugins.dap.extensions.dap-ui.layouts.*.size
Size of the layout in lines/columns.
Type: signed integer
Default: 10
Declared by:
plugins.dap.extensions.dap-ui.mappings
Keys to trigger actions in elements.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.edit
Map edit for dap-ui
default: e
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.expand
Map expand for dap-ui
default: ["<CR>" "<2-LeftMouse>"]
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.open
Map open for dap-ui
default: o
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.remove
Map remove for dap-ui
default: d
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.repl
Map repl for dap-ui
default: r
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.mappings.toggle
Map toggle for dap-ui
default: t
Type: null or string or list of string
Default: null
Declared by:
plugins.dap.extensions.dap-ui.render
Rendering options which can be updated after initial setup.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.extensions.dap-ui.render.indent
Default indentation size.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.dap.extensions.dap-ui.render.maxTypeLength
Maximum number of characters to allow a type name to fill before trimming.
Type: null or signed integer
Default: null
Declared by:
plugins.dap.extensions.dap-ui.render.maxValueLines
Maximum number of lines to allow a value to fill before trimming.
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.dap.extensions.dap-ui.selectWindow
A function which returns a window to be used for opening buffers such as a stack frame location.
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.enable
Whether to enable dap-virtual-text.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dap.extensions.dap-virtual-text.enabledCommands
Create commands DapVirtualTextEnable, DapVirtualTextDisable, DapVirtualTextToggle. (DapVirtualTextForceRefresh for refreshing when debug adapter did not notify its termination).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.package
Plugin to use for dap-virtual-text
Type: package
Default: <derivation vimplugin-nvim-dap-virtual-text-2023-05-25>
Declared by:
plugins.dap.extensions.dap-virtual-text.allFrames
Show virtual text for all stack frames not only current.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.allReferences
Show virtual text on all all references of the variable (not only definitions).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.clearOnContinue
Clear virtual text on continue (might cause flickering when stepping).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.commented
Prefix virtual text with comment string.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.displayCallback
A callback that determines how a variable is displayed or whether it should be omitted.
default: function(variable, buf, stackframe, node, options) if options.virt_text_pos == 'inline' then return ' = ' .. variable.value else return variable.name .. ' = ' .. variable.value end end,
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.highlightChangedVariables
Highlight changed values with NvimDapVirtualTextChanged, else always NvimDapVirtualText.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.highlightNewAsChanged
Highlight new variables in the same way as changed variables (if highlightChangedVariables).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.onlyFirstDefinition
Only show virtual text at first definition (if there are multiple).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.showStopReason
Show stop reason when stopped for exceptions.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.virtLines
Show virtual lines instead of virtual text (will flicker!).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.virtTextPos
Position of virtual text, see :h nvim_buf_set_extmark(). Default tries to inline the virtual text. Use ‘eol’ to set to end of line.
default: vim.fn.has 'nvim-0.10' == 1 and 'inline' or 'eol'
Type: null or string
Default: null
Declared by:
plugins.dap.extensions.dap-virtual-text.virtTextWinCol
Position the virtual text at a fixed window column (starting from the first text column). See :h nvim_buf_set_extmark().
Type: null or signed integer
Default: null
Declared by:
plugins.dap.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.dap.signs
Signs for dap.
Type: null or (submodule)
Default: null
Declared by:
plugins.dap.signs.dapBreakpoint.linehl
linehl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpoint.numhl
numhl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpoint.text
Sign for breakpoints.
default: B
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpoint.texthl
texthl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointCondition.linehl
linehl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointCondition.numhl
numhl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointCondition.text
Sign for conditional breakpoints.
default: C
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointCondition.texthl
texthl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointRejected.linehl
linehl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointRejected.numhl
numhl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointRejected.text
Sign to indicate breakpoints rejected by the debug adapter.
default: R
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapBreakpointRejected.texthl
texthl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapLogPoint.linehl
linehl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapLogPoint.numhl
numhl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapLogPoint.text
Sign for log points.
default: L
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapLogPoint.texthl
texthl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapStopped.linehl
linehl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapStopped.numhl
numhl for sign.
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapStopped.text
Sign to indicate where the debugee is stopped.
default: →
Type: null or string
Default: null
Declared by:
plugins.dap.signs.dapStopped.texthl
texthl for sign.
Type: null or string
Default: null
Declared by:
plugins.dashboard.enable
Whether to enable dashboard.
Type: boolean
Default: false
Example: true
Declared by:
plugins.dashboard.package
Plugin to use for dashboard
Type: package
Default: <derivation vimplugin-dashboard-nvim-2023-06-14>
Declared by:
plugins.dashboard.center
Center section
Type: null or (list of (submodule))
Default: null
Declared by:
plugins.dashboard.center.*.action
Item action
Type: null or string
Default: null
Declared by:
plugins.dashboard.center.*.desc
Item description
Type: string
Declared by:
plugins.dashboard.center.*.icon
Item icon
Type: null or string
Default: null
Declared by:
plugins.dashboard.center.*.shortcut
Item shortcut
Type: null or string
Default: null
Declared by:
plugins.dashboard.footer
Footer text
Type: null or (list of string)
Default: null
Declared by:
plugins.dashboard.header
Header text
Type: null or (list of string)
Default: null
Declared by:
plugins.dashboard.hideStatusline
Whether to hide statusline in Dashboard buffer
Type: null or boolean
Default: null
Declared by:
plugins.dashboard.hideTabline
Whether to hide tabline in Dashboard buffer
Type: null or boolean
Default: null
Declared by:
plugins.dashboard.preview
Preview options
Type: submodule
Default: { }
Declared by:
plugins.dashboard.preview.command
Command to print file contents
Type: null or string
Default: null
Declared by:
plugins.dashboard.preview.file
Path to preview file
Type: null or string
Default: null
Declared by:
plugins.dashboard.preview.height
The height of the preview file
Type: null or signed integer
Default: null
Declared by:
plugins.dashboard.preview.width
The width of the preview file
Type: null or signed integer
Default: null
Declared by:
plugins.dashboard.sessionDirectory
Path to session file
Type: null or string
Default: null
Declared by:
plugins.diffview.enable
Whether to enable diffview.
Type: boolean
Default: false
Example: true
Declared by:
plugins.diffview.package
Plugin to use for diffview
Type: package
Default: <derivation vimplugin-diffview.nvim-2023-07-08>
Declared by:
plugins.diffview.commitLogPanel.winConfig.height
The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".
default: ``
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.position
Determines where the panel is positioned (only when type="split").
default: ""
Type: null or one of “left”, “top”, “right”, “bottom”
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.relative
Determines what the position is relative to (when type="split").
default: "editor"
Type: null or one of “editor”, “win”
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.type
Determines whether the window should be a float or a normal split.
default: "float"
Type: null or one of “split”, “float”
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.width
The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".
default: ``
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.win
The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.commitLogPanel.winConfig.winOpts
Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.
default: {}
Type: null or (attribute set)
Default: null
Declared by:
plugins.diffview.defaultArgs.diffviewFileHistory
Default args prepended to the arg-list for the listed commands
default: [ ]
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.defaultArgs.diffviewOpen
Default args prepended to the arg-list for the listed commands
default: [ ]
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.diffBinaries
Show diffs for binaries
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.disableDefaultKeymaps
Disable the default keymaps;
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.enhancedDiffHl
See ‘:h diffview-config-enhanced_diff_hl’
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.all
Include all refs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.author
Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.base
Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.cherryPick
Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.diffMerges
Determines how merge commits are treated.
Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.firstParent
Follow only the first parent upon seeing a merge commit.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.follow
Follow renames (only for single file).
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.g
Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.grep
Limit the commits output to ones with log message that matches the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.l
{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }
Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.leftOnly
List only the commits on the left side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.maxCount
Limit the number of commits.
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.merges
List only merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.noMerges
List no merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.pathArgs
Limit the target files to only the files matching the given path arguments (git pathspec is supported).
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.reflog
Include all reachable objects mentioned by reflogs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.revRange
List only the commits in the specified revision range.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.reverse
List commits in reverse order.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.rightOnly
List only the commits on the right side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.s
Look for differences that change the number of occurences of the specified pattern (extended regular expression) in a file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.multiFile.showPulls
Show merge commits that are not TREESAME to its first parent, but are to a later parent.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.all
Include all refs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.author
Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.base
Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.cherryPick
Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.diffMerges
Determines how merge commits are treated.
Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.firstParent
Follow only the first parent upon seeing a merge commit.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.follow
Follow renames (only for single file).
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.g
Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.grep
Limit the commits output to ones with log message that matches the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.l
{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }
Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.leftOnly
List only the commits on the left side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.maxCount
Limit the number of commits.
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.merges
List only merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.noMerges
List no merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.pathArgs
Limit the target files to only the files matching the given path arguments (git pathspec is supported).
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.reflog
Include all reachable objects mentioned by reflogs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.revRange
List only the commits in the specified revision range.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.reverse
List commits in reverse order.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.rightOnly
List only the commits on the right side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.s
Look for differences that change the number of occurences of the specified pattern (extended regular expression) in a file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.git.singleFile.showPulls
Show merge commits that are not TREESAME to its first parent, but are to a later parent.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.all
Include all refs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.author
Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.base
Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.cherryPick
Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.diffMerges
Determines how merge commits are treated.
Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.firstParent
Follow only the first parent upon seeing a merge commit.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.follow
Follow renames (only for single file).
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.g
Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.grep
Limit the commits output to ones with log message that matches the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.l
{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }
Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.leftOnly
List only the commits on the left side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.maxCount
Limit the number of commits.
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.merges
List only merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.noMerges
List no merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.pathArgs
Limit the target files to only the files matching the given path arguments (git pathspec is supported).
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.reflog
Include all reachable objects mentioned by reflogs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.revRange
List only the commits in the specified revision range.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.reverse
List commits in reverse order.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.rightOnly
List only the commits on the right side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.s
Look for differences that change the number of occurences of the specified pattern (extended regular expression) in a file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.multiFile.showPulls
Show merge commits that are not TREESAME to its first parent, but are to a later parent.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.all
Include all refs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.author
Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.base
Specify a base git rev from which the right side of the diff will be created. Use the special value LOCAL to use the local version of the file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.cherryPick
Omit commits that introduce the same change as another commit on the “other side” when the set of commits are limited with symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.diffMerges
Determines how merge commits are treated.
Type: null or one of “off”, “on”, “first-parent”, “separate”, “combined”, “dense-combined”, “remerge”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.firstParent
Follow only the first parent upon seeing a merge commit.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.follow
Follow renames (only for single file).
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.g
Look for differences whose patch text contains added/removed lines that match the specified pattern (extended regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.grep
Limit the commits output to ones with log message that matches the specified pattern (regular expression).
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.l
{ ("<start>,<end>:<file>" | ":<funcname>:<file>")... }
Trace the evolution of the line range given by <start>,<end>, or by the function name regex <funcname>, within the <file>.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.leftOnly
List only the commits on the left side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.maxCount
Limit the number of commits.
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.merges
List only merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.noMerges
List no merge commits.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.pathArgs
Limit the target files to only the files matching the given path arguments (git pathspec is supported).
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.reflog
Include all reachable objects mentioned by reflogs.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.revRange
List only the commits in the specified revision range.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.reverse
List commits in reverse order.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.rightOnly
List only the commits on the right side of a symmetric difference.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.s
Look for differences that change the number of occurences of the specified pattern (extended regular expression) in a file.
Type: null or string
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.logOptions.hg.singleFile.showPulls
Show merge commits that are not TREESAME to its first parent, but are to a later parent.
Type: null or boolean
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.height
The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".
default: 16
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.position
Determines where the panel is positioned (only when type="split").
default: "bottom"
Type: null or one of “left”, “top”, “right”, “bottom”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.relative
Determines what the position is relative to (when type="split").
default: "editor"
Type: null or one of “editor”, “win”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.type
Determines whether the window should be a float or a normal split.
default: "split"
Type: null or one of “split”, “float”
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.width
The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".
default: ``
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.win
The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.fileHistoryPanel.winConfig.winOpts
Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.
default: {}
Type: null or (attribute set)
Default: null
Declared by:
plugins.diffview.filePanel.listingStyle
One of ‘list’ or ‘tree’
default: "tree"
Type: null or one of “list”, “tree”
Default: null
Declared by:
plugins.diffview.filePanel.treeOptions.flattenDirs
Flatten dirs that only contain one single dir Only applies when listing_style is ‘tree’
default: true
Type: null or boolean
Default: null
Declared by:
plugins.diffview.filePanel.treeOptions.folderStatuses
One of ‘never’, ‘only_folded’ or ‘always’. Only applies when listing_style is ‘tree’
default: "only_folded"
Type: null or one of “never”, “only_folded”, “always”
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.height
The height of the window (in character cells). If type is "split" then this is only applicable when position is "top"|"bottom".
default: ``
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.position
Determines where the panel is positioned (only when type="split").
default: "left"
Type: null or one of “left”, “top”, “right”, “bottom”
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.relative
Determines what the position is relative to (when type="split").
default: "editor"
Type: null or one of “editor”, “win”
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.type
Determines whether the window should be a float or a normal split.
default: "split"
Type: null or one of “split”, “float”
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.width
The width of the window (in character cells). If type is "split" then this is only applicable when position is "left"|"right".
default: 35
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.win
The window handle of the target relative window (when type="split". Only when relative="win"). Use 0 for current window.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.diffview.filePanel.winConfig.winOpts
Table of window local options (see |vim.opt_local|). These options are applied whenever the window is opened.
default: {}
Type: null or (attribute set)
Default: null
Declared by:
plugins.diffview.gitCmd
The git executable followed by default args.
default: [ "git" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.hgCmd
The hg executable followed by default args.
default: [ "hg" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.diffview.hooks.diffBufRead
{diff_buf_read} (fun(bufnr: integer, ctx: table))
Emitted after a new diff buffer is ready (the first time it's
created and loaded into a window). Diff buffers are all
buffers with |diff-mode| enabled. That includes buffers of
local files (not created from git).
This is always called with the new buffer as the current
buffer and the correct diff window as the current window such
that |:setlocal| will apply settings to the relevant buffer /
window.
Callback Parameters:
{bufnr} (`integer`)
The buffer number of the new buffer.
{ctx} (`table`)
• {symbol} (string)
A symbol that identifies the window's position in
the layout. These symbols correspond with the
figures under |diffview-config-view.x.layout|.
• {layout_name} (string)
The name of the current layout.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.diffBufWinEnter
{diff_buf_win_enter} (fun(bufnr: integer, winid: integer, ctx: table))
Emitted after a diff buffer is displayed in a window.
This is always called with the new buffer as the current
buffer and the correct diff window as the current window such
that |:setlocal| will apply settings to the relevant buffer /
window.
Callback Parameters:
{bufnr} (`integer`)
The buffer number of the new buffer.
{winid} (`integer`)
The window id of window inside which the buffer was
displayed.
{ctx} (`table`)
• {symbol} (string)
A symbol that identifies the window's position in
the layout. These symbols correspond with the
figures under |diffview-config-view.x.layout|.
• {layout_name} (string)
The name of the current layout.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.viewClosed
{view_closed} (fun(view: View))
Emitted after closing a view.
Callback Parameters:
{view} (`View`)
The `View` instance that was closed.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.viewEnter
{view_enter} (fun(view: View))
Emitted just after entering the tabpage of a view.
Callback Parameters:
{view} (`View`)
The `View` instance that was entered.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.viewLeave
{view_leave} (fun(view: View))
Emitted just before leaving the tabpage of a view.
Callback Parameters:
{view} (`View`)
The `View` instance that's about to be left.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.viewOpened
{view_opened} (fun(view: View))
Emitted after a new view has been opened. It’s called after initializing the layout in the new tabpage (all windows are ready).
Callback Parameters: {view} (View) The View instance that was opened.
Type: null or string
Default: null
Declared by:
plugins.diffview.hooks.viewPostLayout
{view_post_layout} (fun(view: View))
Emitted after the window layout in a view has been adjusted.
Callback Parameters:
{view} (`View`)
The `View` whose layout was adjusted.
Type: null or string
Default: null
Declared by:
plugins.diffview.icons.folderClosed
Only applies when use_icons is true.
default:
Type: null or string
Default: null
Declared by:
plugins.diffview.icons.folderOpen
Only applies when use_icons is true.
default:
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.diff1
List of keybindings. Mappings in single window diff layouts
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.diff1.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.diff1.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.diff1.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.diff1.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.diff2
List of keybindings. Mappings in 2-way diff layouts
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.diff2.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.diff2.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.diff2.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.diff2.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.diff3
List of keybindings. Mappings in 3-way diff layouts
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.diff3.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.diff3.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.diff3.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.diff3.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.diff4
List of keybindings. Mappings in 4-way diff layouts
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.diff4.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.diff4.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.diff4.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.diff4.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.disableDefaults
Disable the default keymaps.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.keymaps.fileHistoryPanel
List of keybindings. Mappings in file history panel.
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.fileHistoryPanel.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.fileHistoryPanel.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.fileHistoryPanel.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.fileHistoryPanel.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.filePanel
List of keybindings. Mappings in file panel.
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.filePanel.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.filePanel.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.filePanel.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.filePanel.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.helpPanel
List of keybindings. Mappings in help panel.
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.helpPanel.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.helpPanel.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.helpPanel.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.helpPanel.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.optionPanel
List of keybindings. Mappings in options panel.
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.optionPanel.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.optionPanel.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.optionPanel.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.optionPanel.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.keymaps.view
List of keybindings. The view bindings are active in the diff buffers, only when the current tabpage is a Diffview.
Type: list of (submodule)
Default: [ ]
Example:
[
{
action = "actions.select_next_entry";
description = "Open the diff for the next file";
key = "<tab>";
mode = "n";
}
]
Declared by:
plugins.diffview.keymaps.view.*.action
action for keybinding
Type: string
Example: "action.select_next_entry"
Declared by:
plugins.diffview.keymaps.view.*.description
description for keybinding
Type: null or string
Default: null
Declared by:
plugins.diffview.keymaps.view.*.key
key to bind keybinding to
Type: string
Example: "<tab>"
Declared by:
plugins.diffview.keymaps.view.*.mode
mode to bind keybinding to
Type: string
Example: "n"
Declared by:
plugins.diffview.showHelpHints
Show hints for how to open the help panel
default: true
Type: null or boolean
Default: null
Declared by:
plugins.diffview.signs.done
default: ✓
Type: null or string
Default: null
Declared by:
plugins.diffview.signs.foldClosed
default:
Type: null or string
Default: null
Declared by:
plugins.diffview.signs.foldOpen
default:
Type: null or string
Default: null
Declared by:
plugins.diffview.useIcons
Requires nvim-web-devicons
Type: boolean
Default: true
Declared by:
plugins.diffview.view.default.layout
Config for changed files, and staged files in diff views. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.
-
A: Old state
-
B: New state
diff2_horizontal:
| A | B |
diff2_vertical:
A
─
B
default: "diff2_horizontal"
Type: null or one of “diff2_horizontal”, “diff2_vertical”
Default: null
Declared by:
plugins.diffview.view.default.winbarInfo
See ‘:h diffview-config-view.x.winbar_info’
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.view.fileHistory.layout
Config for changed files in file history views. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.
-
A: Old state
-
B: New state
diff2_horizontal:
| A | B |
diff2_vertical:
A
─
B
default: "diff2_horizontal"
Type: null or one of “diff2_horizontal”, “diff2_vertical”
Default: null
Declared by:
plugins.diffview.view.fileHistory.winbarInfo
See ‘:h diffview-config-view.x.winbar_info’
default: false
Type: null or boolean
Default: null
Declared by:
plugins.diffview.view.mergeTool.disableDiagnostics
Temporarily disable diagnostics for conflict buffers while in the view.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.diffview.view.mergeTool.layout
Config for conflicted files in diff views during a merge or rebase. Configure the layout and behavior of different types of views. For more info, see ‘:h diffview-config-view.x.layout’.
-
A: OURS (current branch)
-
B: LOCAL (the file as it currently exists on disk)
-
C: THEIRS (incoming branch)
-
D: BASE (common ancestor)
diff1_plain:
B
diff3_horizontal:
A | B | C
diff3_vertical:
A
B
C
diff3_mixed:
A | C
B
diff4_mixed:
A | D | C
B
default: "diff3_horizontal"
Type: null or one of “diff1_plain”, “diff3_horizontal”, “diff3_vertical”, “diff3_mixed”, “diff4_mixed”
Default: null
Declared by:
plugins.diffview.view.mergeTool.winbarInfo
See ‘:h diffview-config-view.x.winbar_info’
default: true
Type: null or boolean
Default: null
Declared by:
plugins.diffview.watchIndex
Update views and index buffers when the git index changes.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.easyescape.enable
Whether to enable Enable easyescape.
Type: boolean
Default: false
Example: true
Declared by:
plugins.easyescape.package
Plugin to use for easyescape
Type: package
Default: <derivation vimplugin-vim-easyescape-2020-11-22>
Declared by:
plugins.emmet.enable
Whether to enable Enable emmet.
Type: boolean
Default: false
Example: true
Declared by:
plugins.emmet.package
Plugin to use for emmet
Type: package
Default: <derivation vimplugin-emmet-vim-2021-12-04>
Declared by:
plugins.emmet.leader
Set leader key
Type: null or string
Default: null
Example: null
Declared by:
plugins.emmet.mode
Mode where emmet will enable
Type: null or one of “i”, “n”, “v”, “a”
Default: null
Example: null
Declared by:
plugins.emmet.settings
Emmet settings
Type: null or (attribute set of attribute set of (string or signed integer or attribute set of (string or signed integer or attribute set of (string or signed integer))))
Default: null
Example: null
Declared by:
plugins.endwise.enable
Whether to enable Enable vim-endwise.
Type: boolean
Default: false
Example: true
Declared by:
plugins.endwise.package
Plugin to use for endwise
Type: package
Default: <derivation vimplugin-vim-endwise-2023-04-23>
Declared by:
plugins.floaterm.enable
Whether to enable floaterm.
Type: boolean
Default: false
Example: true
Declared by:
plugins.floaterm.package
Plugin to use for floaterm
Type: package
Default: <derivation vimplugin-vim-floaterm-2023-07-10>
Declared by:
plugins.floaterm.autoclose
Whether to close floaterm window once the job gets finished.
-
0: Always do NOT close floaterm window
-
1: Close window if the job exits normally, otherwise stay it with messages like [Process exited 101]
-
2: Always close floaterm window
Default: 1
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.floaterm.autohide
Whether to hide previous floaterms before switching to or opening a another one.
-
0: Always do NOT hide previous floaterm windows
-
1: Only hide those whose position (b:floaterm_position) is identical to that of the floaterm which will be opened
-
2: Always hide them
Default: 1
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.floaterm.autoinsert
Whether to enter Terminal-mode after opening a floaterm.
Default: true
Type: null or boolean
Default: null
Declared by:
plugins.floaterm.borderchars
The position of the floating window.
8 characters of the floating window border (top, right, bottom, left, topleft, topright, botright, botleft).
Default: “─│─│┌┐┘└”
Type: null or string
Default: null
Declared by:
plugins.floaterm.giteditor
Whether to override $GIT_EDITOR in floaterm terminals so git commands can open open an editor in the same neovim instance.
Default: true
Type: null or boolean
Default: null
Declared by:
plugins.floaterm.height
Int (number of columns) or float (between 0 and 1). if float, the height is relative to &lines.
Default: 0.6
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.floaterm.keymaps.first
Key to map to first
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.hide
Key to map to hide
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.kill
Key to map to kill
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.last
Key to map to last
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.new
Key to map to new
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.next
Key to map to next
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.prev
Key to map to prev
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.show
Key to map to show
Type: null or string
Default: null
Declared by:
plugins.floaterm.keymaps.toggle
Key to map to toggle
Type: null or string
Default: null
Declared by:
plugins.floaterm.opener
Command used for opening a file in the outside nvim from within :terminal.
Default: ‘split’
Type: null or one of “edit”, “split”, “vsplit”, “tabe”, “drop”
Default: null
Declared by:
plugins.floaterm.position
The position of the floating window.
Available values:
-
If wintype is
split/vsplit: ‘leftabove’, ‘aboveleft’, ‘rightbelow’, ‘belowright’, ‘topleft’, ‘botright’. Default: ‘botright’. -
If wintype is float: ‘top’, ‘bottom’, ‘left’, ‘right’, ‘topleft’, ‘topright’, ‘bottomleft’, ‘bottomright’, ‘center’, ‘auto’ (at the cursor place). Default: ‘center’
In addition, there is another option ‘random’ which allows to pick a random position from above when (re)opening a floaterm window.
Type: null or string
Default: null
Declared by:
plugins.floaterm.rootmarkers
Markers used to detect the project root directory for --cwd=<root>
Default: [“.project” “.git” “.hg” “.svn” “.root”]
Type: null or (list of string)
Default: null
Declared by:
plugins.floaterm.shell
Type: null or string
Default: null
Declared by:
plugins.floaterm.title
Show floaterm info (e.g., ‘floaterm: 1/3’ implies there are 3 floaterms in total and the current is the first one) at the top left corner of floaterm window.
Default: ‘floaterm: $1/$2’($1 and $2 will be substituted by ‘the index of the current floaterm’ and ‘the count of all floaterms’ respectively)
Example: ‘floaterm($1|$2)’
Type: null or string
Default: null
Declared by:
plugins.floaterm.width
Int (number of columns) or float (between 0 and 1). if float, the width is relative to &columns.
Default: 0.6
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.floaterm.wintype
‘float’(nvim’s floating or vim’s popup) by default. Set it to ‘split’ or ‘vsplit’ if you don’t want to use floating or popup window.
Type: null or one of “float”, “split”, “vsplit”
Default: null
Declared by:
plugins.fugitive.enable
Whether to enable Enable vim-fugitive.
Type: boolean
Default: false
Example: true
Declared by:
plugins.fugitive.package
Plugin to use for fugitive
Type: package
Default: <derivation vimplugin-vim-fugitive-2023-06-12>
Declared by:
plugins.gitgutter.enable
Whether to enable gitgutter.
Type: boolean
Default: false
Example: true
Declared by:
plugins.gitgutter.enableByDefault
Enable gitgutter by default
Type: boolean
Default: true
Declared by:
plugins.gitgutter.package
Plugin to use for gitgutter
Type: package
Default: <derivation vimplugin-vim-gitgutter-2023-06-16>
Declared by:
plugins.gitgutter.allowClobberSigns
Don’t preserve other signs on the sign column
Type: boolean
Default: false
Declared by:
plugins.gitgutter.defaultMaps
Let gitgutter set default mappings
Type: boolean
Default: true
Declared by:
plugins.gitgutter.diffRelativeToWorkingTree
Make diffs relative to the working tree instead of the index
Type: boolean
Default: false
Declared by:
plugins.gitgutter.extraDiffArgs
Extra arguments to pass to git diff
Type: string
Default: ""
Declared by:
plugins.gitgutter.extraGitArgs
Extra arguments to pass to git
Type: string
Default: ""
Declared by:
plugins.gitgutter.grep
A non-standard grep to use instead of the default
Type: null or (submodule) or string
Default: null
Declared by:
plugins.gitgutter.highlightLineNumbers
Highlight line numbers by default
Type: boolean
Default: true
Declared by:
plugins.gitgutter.highlightLines
Highlight lines by default
Type: boolean
Default: true
Declared by:
plugins.gitgutter.matchBackgrounds
Make the background colors match the sign column
Type: boolean
Default: false
Declared by:
plugins.gitgutter.maxSigns
Maximum number of signs to show on the screen. Unlimited by default.
Type: null or signed integer
Default: null
Declared by:
plugins.gitgutter.previewWinFloating
Preview hunks on floating windows
Type: boolean
Default: false
Declared by:
plugins.gitgutter.recommendedSettings
Use recommended settings
Type: boolean
Default: true
Declared by:
plugins.gitgutter.runAsync
Disable this to run git diff syncrhonously instead of asynchronously
Type: boolean
Default: true
Declared by:
plugins.gitgutter.showMessageOnHunkJumping
Show a message when jumping between hunks
Type: boolean
Default: true
Declared by:
plugins.gitgutter.signPriority
GitGutter’s sign priority on the sign column
Type: null or signed integer
Default: null
Declared by:
plugins.gitgutter.signs
Custom signs for the sign column
Type: submodule
Default: { }
Declared by:
plugins.gitgutter.signs.added
Sign for added lines
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.modified
Sign for modified lines
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.modifiedAbove
Sign for modified line above
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.modifiedRemoved
Sign for modified and removed lines
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.removed
Sign for removed lines
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.removedAboveAndBelow
Sign for lines removed above and below
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signs.removedFirstLine
Sign for a removed first line
Type: null or string
Default: null
Declared by:
plugins.gitgutter.signsByDefault
Show signs by default
Type: boolean
Default: true
Declared by:
plugins.gitgutter.terminalReportFocus
Let the terminal report its focus status
Type: boolean
Default: true
Declared by:
plugins.gitgutter.useLocationList
Load chunks into windows’s location list instead of the quickfix list
Type: boolean
Default: false
Declared by:
plugins.gitmessenger.enable
Whether to enable Enable the gitmessenger plugin.
Type: boolean
Default: false
Example: true
Declared by:
plugins.gitmessenger.package
Plugin to use for git-messenger
Type: package
Default: <derivation vimplugin-git-messenger.vim-2022-08-30>
Declared by:
plugins.gitmessenger.alwaysIntoPopup
When this value is set to v:true, the cursor goes into a popup window when running :GitMessenger or <Plug>(git-messenger).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.closeOnCursorMoved
A popup window is no longer closed automatically when moving a cursor after the window is shown up.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.concealWordDiffMarker
When this value is set to v:true, markers for word diffs like [-, -], {+, +} are concealed. Set false when you don’t want to hide them.
Note: Word diff is enabled by typing “r” in a popup window.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.dateFormat
String value to format dates in popup window. Please see :help strftime() to know the details of the format.
default: %c
Type: null or string
Default: null
Declared by:
plugins.gitmessenger.extraBlameArgs
When this variable is set the contents will be appended to the git blame command. Use it to add options (like -w).
default: ``
Type: null or string
Default: null
Declared by:
plugins.gitmessenger.floatingWinOps
Options passed to nvim_open_win() on opening a popup window. This is useful when you want to override some window options.
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.gitmessenger.gitCommand
git command to retrieve commit messages.
default: git
Type: null or string
Default: null
Declared by:
plugins.gitmessenger.includeDiff
When this value is not set to “none”, a popup window includes diff hunks of the commit at showing up. “current” includes diff hunks of only current file in the commit. “all” includes all diff hunks in the commit.
Please note that typing d/D or r/R in popup window toggle showing diff hunks even if this value is set to “none”.
default: "none"
Type: null or one of “none”, “current”, “all”
Default: null
Declared by:
plugins.gitmessenger.intoPopupAfterShow
When this value is set to v:false, running :GitMessenger or <plug>(git-messenger) again after showing a popup does not move the cursor in the window.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.maxPopupHeight
Max lines of popup window in an integer value. Setting null means no limit.
Type: null or signed integer
Default: null
Declared by:
plugins.gitmessenger.maxPopupWidth
Max characters of popup window in an integer value. Setting null means no limit.
Type: null or signed integer
Default: null
Declared by:
plugins.gitmessenger.noDefaultMappings
When this value is set, it does not define any key mappings
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.popupContentMargins
Setting true means adding margins in popup window. Blank lines at the top and bottom of popup content are inserted. And every line is indented with one whitespace character. Setting false to this variable removes all the margins.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitmessenger.previewMods
This variable is effective only when opening preview window (on Neovim (0.3.0 or earlier) or Vim).
Command modifiers for opening preview window. The value will be passed as prefix of :pedit command. For example, setting “botright” to the variable opens a preview window at bottom of the current window. Please see :help <mods> for more details.
default: ``
Type: null or string
Default: null
Declared by:
plugins.gitsigns.enable
Whether to enable Enable gitsigns plugin.
Type: boolean
Default: false
Example: true
Declared by:
plugins.gitsigns.package
Plugin to use for gitsigns
Type: package
Default: <derivation lua5.1-gitsigns.nvim-2023-07-04>
Declared by:
plugins.gitsigns.attachToUntracked
Attach to untracked files.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.base
The object/revision to diff against. Default to ‘index’
Type: null or string
Default: null
Declared by:
plugins.gitsigns.countChars
The count characters used when signs.*.show_count is enabled. The + entry is used as a fallback. With the default, any count outside of 1-9 uses the > character in the sign.
Possible use cases for this field: • to specify unicode characters for the counts instead of 1-9. • to define characters to be used for counts greater than 9.
default: { "1" = "1"; "2" = "2"; "3" = "3"; "4" = "4"; "5" = "5"; "6" = "6"; "7" = "7"; "8" = "8"; "9" = "9"; "+" = ">"; }
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.gitsigns.currentLineBlame
Adds an unobtrusive and customisable blame annotation at the end of the current line.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.currentLineBlameFormatter.nonCommitted
String or function used to format the virtual text of |gitsigns-config-current_line_blame| for lines that aren’t committed.
default: " <author>"
Type: null or string or (submodule)
Default: null
Declared by:
plugins.gitsigns.currentLineBlameFormatter.normal
String or function used to format the virtual text of |gitsigns-config-current_line_blame|.
See |gitsigns-config-current_line_blame_formatter| for more details.
default: " <author>, <author_time> - <summary>"
Type: null or string or (submodule)
Default: null
Declared by:
plugins.gitsigns.currentLineBlameOpts.delay
Sets the delay (in milliseconds) before blame virtual text is displayed
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.currentLineBlameOpts.ignoreWhitespace
Ignore whitespace when running blame
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.currentLineBlameOpts.virtText
Whether to show a virtual text blame annotation
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.currentLineBlameOpts.virtTextPos
Blame annotation position
default: "eol"
Type: null or one of “eol”, “overlay”, “right_align”
Default: null
Declared by:
plugins.gitsigns.currentLineBlameOpts.virtTextPriority
Priority of virtual text
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.debugMode
Enables debug logging and makes the following functions available: dump_cache, debug_messages, clear_debug.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.diffOpts
Diff options. If set to null they are derived from the vim diffopt
Type: null or (submodule)
Default: null
Declared by:
plugins.gitsigns.diffOpts.algorithm
Diff algorithm to use
default: "myers"
Type: null or one of “myers”, “minimal”, “patience”, “histogram”
Default: null
Declared by:
plugins.gitsigns.diffOpts.indentHeuristic
Use the indent heuristic for the internal diff library.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.diffOpts.internal
Use Neovim’s built in xdiff library for running diffs
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.diffOpts.linematch
Enable second-stage diff on hunks to align lines. Requires internal=true.
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.diffOpts.vertical
Start diff mode with vertical splits
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.linehl
line highlights.
When enabled the highlights defined in signs.*.linehl are used. If the highlight group does not exist, then it is automatically defined and linked to the corresponding highlight group in signs.*.hl.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.maxFileLength
Max file length (in lines) to attach to
default: 40000
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.numhl
line number highlights.
When enabled the highlights defined in signs.*.numhl are used. If the highlight group does not exist, then it is automatically defined and linked to the corresponding highlight group in signs.*.hl.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.onAttach
Callback called when attaching to a buffer. Mainly used to setup keymaps when config.keymaps is empty. The buffer number is passed as the first argument.
This callback can return false to prevent attaching to the buffer.
Type: null or (submodule)
Default: null
Example:
''
\'\'
function(bufnr)
if vim.api.nvim_buf_get_name(bufnr):match(<PATTERN>) then
-- Don't attach to specific buffers whose name matches a pattern
return false
end
-- Setup keymaps
vim.api.nvim_buf_set_keymap(bufnr, 'n', 'hs', '<cmd>lua require"gitsigns".stage_hunk()<CR>', {})
... -- More keymaps
end
\'\'
''
Declared by:
plugins.gitsigns.onAttach.function
Lua function definition
Type: string
Declared by:
plugins.gitsigns.previewConfig
Option overrides for the Gitsigns preview window. Table is passed directly to nvim_open_win.
default: { border = "single"; style = "minimal"; relative = "cursor"; row = 0; col = 1; }
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.gitsigns.showDeleted
showing the old version of hunks inline in the buffer (via virtual lines).
Note: Virtual lines currently use the highlight GitSignsDeleteVirtLn.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signPriority
Priority to use for signs
default: 6
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.signcolumn
Enable/disable symbols in the sign column.
When enabled the highlights defined in signs.*.hl and symbols defined in signs.*.text are used.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.add.hl
Specifies the highlight group to use for the sign
default: GitSignsAdd
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.add.linehl
Specifies the highlight group to use for the line
default: GitSignsAddLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.add.numhl
Specifies the highlight group to use for the number column
default: GitSignsAddNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.add.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.add.text
Specifies the character to use for the sign
default: ┃
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.change.hl
Specifies the highlight group to use for the sign
default: GitSignsChange
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.change.linehl
Specifies the highlight group to use for the line
default: GitSignsChangeLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.change.numhl
Specifies the highlight group to use for the number column
default: GitSignsChangeNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.change.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.change.text
Specifies the character to use for the sign
default: ┃
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.changedelete.hl
Specifies the highlight group to use for the sign
default: GitSignsChange
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.changedelete.linehl
Specifies the highlight group to use for the line
default: GitSignsChangeLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.changedelete.numhl
Specifies the highlight group to use for the number column
default: GitSignsChangeNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.changedelete.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.changedelete.text
Specifies the character to use for the sign
default: ~
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.delete.hl
Specifies the highlight group to use for the sign
default: GitSignsDelete
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.delete.linehl
Specifies the highlight group to use for the line
default: GitSignsDeleteLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.delete.numhl
Specifies the highlight group to use for the number column
default: GitSignsDeleteNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.delete.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.delete.text
Specifies the character to use for the sign
default: ▁
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.topdelete.hl
Specifies the highlight group to use for the sign
default: GitSignsDelete
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.topdelete.linehl
Specifies the highlight group to use for the line
default: GitSignsDeleteLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.topdelete.numhl
Specifies the highlight group to use for the number column
default: GitSignsDeleteNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.topdelete.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.topdelete.text
Specifies the character to use for the sign
default: ▔
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.untracked.hl
Specifies the highlight group to use for the sign
default: GitSignsAdd
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.untracked.linehl
Specifies the highlight group to use for the line
default: GitSignsAddLn
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.untracked.numhl
Specifies the highlight group to use for the number column
default: GitSignsAddNr
Type: null or string
Default: null
Declared by:
plugins.gitsigns.signs.untracked.showCount
showing count of hunk, e.g. number of deleted lines
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.signs.untracked.text
Specifies the character to use for the sign
default: ┆
Type: null or string
Default: null
Declared by:
plugins.gitsigns.statusFormatter
Function used to format b:gitsigns_status
default: { function = \'\' function(status) local added, changed, removed = status.added, status.changed, status.removed local status_txt = {} if added and added > 0 then table.insert(status_txt, '+'..added ) end if changed and changed > 0 then table.insert(status_txt, '~'..changed) end if removed and removed > 0 then table.insert(status_txt, '-'..removed) end return table.concat(status_txt, ' ') end \'\'; }
Type: null or (submodule)
Default: null
Declared by:
plugins.gitsigns.statusFormatter.function
Lua function definition
Type: string
Declared by:
plugins.gitsigns.trouble
When using setqflist() or setloclist(), open Trouble instead of the quickfix/location list window.
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.updateDebounce
Debounce time for updates (in milliseconds).
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.watchGitDir.enable
Whether the watcher is enabled
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.watchGitDir.followFiles
If a file is moved with git mv, switch the buffer to the new location
default: true
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.watchGitDir.interval
Interval the watcher waits between polls of the gitdir in milliseconds
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.gitsigns.wordDiff
Highlight intra-line word differences in the buffer. Requires config.diff_opts.internal = true.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.gitsigns.worktrees
Detached working trees. If normal attaching fails, then each entry in the table is attempted with the work tree details set.
Type: null or (list of (submodule))
Default: null
Declared by:
plugins.gitsigns.worktrees.*.gitdir
This option has no description.
Type: string
Declared by:
plugins.gitsigns.worktrees.*.toplevel
This option has no description.
Type: string
Declared by:
plugins.gitsigns.yadm.enable
YADM support
default: false
Type: null or boolean
Default: null
Declared by:
plugins.goyo.enable
Whether to enable Enable goyo.vim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.goyo.package
Plugin to use for goyo
Type: package
Default: <derivation vimplugin-goyo.vim-2023-03-04>
Declared by:
plugins.goyo.height
Height
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.goyo.showLineNumbers
Show line numbers when in Goyo mode
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.goyo.width
Width
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.harpoon.enable
Whether to enable harpoon.
Type: boolean
Default: false
Example: true
Declared by:
plugins.harpoon.package
Plugin to use for harpoon
Type: package
Default: <derivation vimplugin-harpoon-2023-05-28>
Declared by:
plugins.harpoon.enterOnSendcmd
Sets harpoon to run the command immediately as it’s passed to the terminal when calling sendCommand.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.harpoon.excludedFiletypes
Filetypes that you want to prevent from adding to the harpoon list menu.
default: ['harpoon']
Type: null or (list of string)
Default: null
Declared by:
plugins.harpoon.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.harpoon.keymaps.addFile
Keymap for marking the current file.";
Type: null or string
Default: null
Declared by:
plugins.harpoon.keymaps.cmdToggleQuickMenu
Keymap for toggling the cmd quick menu.
Type: null or string
Default: null
Declared by:
plugins.harpoon.keymaps.gotoTerminal
Keymaps for navigating to terminals.
Examples: gotoTerminal = { “1” = “<C-j>”; “2” = “<C-k>”; “3” = “<C-l>”; “4” = “<C-m>”; };
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.harpoon.keymaps.navFile
Keymaps for navigating to marks.
Examples: navFile = { “1” = “<C-j>”; “2” = “<C-k>”; “3” = “<C-l>”; “4” = “<C-m>”; };
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.harpoon.keymaps.navNext
Keymap for navigating to next mark.";
Type: null or string
Default: null
Declared by:
plugins.harpoon.keymaps.navPrev
Keymap for navigating to previous mark.";
Type: null or string
Default: null
Declared by:
plugins.harpoon.keymaps.tmuxGotoTerminal
Keymaps for navigating to tmux windows/panes. Attributes can either be tmux window ids or pane identifiers.
Examples: tmuxGotoTerminal = { “1” = “<C-1>”; “2” = “<C-2>”; “{down-of}” = “<leader>g”; };
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.harpoon.keymaps.toggleQuickMenu
Keymap for toggling the quick menu.";
Type: null or string
Default: null
Declared by:
plugins.harpoon.keymapsSilent
Whether harpoon keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.harpoon.markBranch
Set marks specific to each git branch inside git repository.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.harpoon.menu.borderChars
Border characters
default: [ "─" "│" "─" "│" "╭" "╮" "╯" "╰" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.harpoon.menu.height
Menu window height
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.harpoon.menu.width
Menu window width
default: 60
Type: null or signed integer
Default: null
Declared by:
plugins.harpoon.projects
Predefined projetcs. The keys of this attrs should be the path to the project. $HOME is working.
Type: attribute set of (submodule)
Default: { }
Example:
''
projects = {
"$HOME/personal/vim-with-me/server" = {
term.cmds = [
"./env && npx ts-node src/index.ts"
];
};
};
''
Declared by:
plugins.harpoon.projects.<name>.marks
List of predefined marks (filenames) for this project.
Type: null or (list of string)
Default: null
Declared by:
plugins.harpoon.projects.<name>.termCommands
List of predefined terminal commands for this project.
Type: null or (list of string)
Default: null
Declared by:
plugins.harpoon.saveOnChange
Saves the harpoon file upon every change. disabling is unrecommended.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.harpoon.saveOnToggle
Sets the marks upon calling toggle on the ui, instead of require :w.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.harpoon.tmuxAutocloseWindows
Closes any tmux windows harpoon that harpoon creates when you close Neovim.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.illuminate.enable
Whether to enable vim-illuminate.
Type: boolean
Default: false
Example: true
Declared by:
plugins.illuminate.package
Plugin to use for vim-illuminate
Type: package
Default: <derivation vimplugin-vim-illuminate-2023-03-19>
Declared by:
plugins.illuminate.delay
Delay in milliseconds.
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.illuminate.filetypeOverrides
Filetype specific overrides.
Type: list of (submodule)
Default: [ ]
Declared by:
plugins.illuminate.filetypeOverrides.*.filetype
Filetype to override
default: ``
Type: null or string
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.delay
Delay in milliseconds.
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.largeFileCutoff
Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.minCountToHighlight
Minimum number of matches required to perform highlighting.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.modesAllowlist
Modes to illuminate, this is overriden by modes_denylist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.modesDenylist
Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.providers
Provider used to get references in the buffer, ordered by priority.
default: ["lsp" "treesitter" "regex"]
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.providersRegexSyntaxAllowlist
Syntax to illuminate, this is overriden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.providersRegexSyntaxDenylist
Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypeOverrides.*.overrides.underCursor
Whether or not to illuminate under the cursor.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.illuminate.filetypesAllowlist
Filetypes to illuminate, this is overriden by filetypes_denylist.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.filetypesDenylist
Filetypes to not illuminate, this overrides filetypes_allowlist.
default: ["dirvish" "fugitive"]
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileCutoff
Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.largeFileOverrides
Config to use for large files (based on large_file_cutoff). Supports the same keys passed to .configure If null, illuminate will be disabled for large files.
Type: submodule
Default: { }
Declared by:
plugins.illuminate.largeFileOverrides.delay
Delay in milliseconds.
default: 100
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.filetypesAllowlist
Filetypes to illuminate, this is overriden by filetypes_denylist.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.filetypesDenylist
Filetypes to not illuminate, this overrides filetypes_allowlist.
default: ["dirvish" "fugitive"]
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.largeFileCutoff
Number of lines at which to use large_file_config. The under_cursor option is disabled when this cutoff is hit.
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.minCountToHighlight
Minimum number of matches required to perform highlighting.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.modesAllowlist
Modes to illuminate, this is overriden by modes_denylist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.modesDenylist
Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.providers
Provider used to get references in the buffer, ordered by priority.
default: ["lsp" "treesitter" "regex"]
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.providersRegexSyntaxAllowlist
Syntax to illuminate, this is overriden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.providersRegexSyntaxDenylist
Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.largeFileOverrides.underCursor
Whether or not to illuminate under the cursor.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.illuminate.minCountToHighlight
Minimum number of matches required to perform highlighting.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.illuminate.modesAllowlist
Modes to illuminate, this is overriden by modes_denylist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.modesDenylist
Modes to not illuminate, this overrides modes_allowlist. See :help mode() for possible values.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.providers
Provider used to get references in the buffer, ordered by priority.
default: ["lsp" "treesitter" "regex"]
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.providersRegexSyntaxAllowlist
Syntax to illuminate, this is overriden by providers_regex_syntax_denylist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.providersRegexSyntaxDenylist
Syntax to not illuminate, this overrides providers_regex_syntax_allowlist. Only applies to the ‘regex’ provider. Use :echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name').
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.illuminate.underCursor
Whether or not to illuminate under the cursor.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.inc-rename.enable
Whether to enable inc-rename, a plugin previewing LSP renaming.
Type: boolean
Default: false
Example: true
Declared by:
plugins.inc-rename.package
Plugin to use for inc-rename
Type: package
Default: <derivation vimplugin-inc-rename.nvim-2023-06-03>
Declared by:
plugins.inc-rename.cmdName
the name of the command
default: IncRename
Type: null or string
Default: null
Declared by:
plugins.inc-rename.hlGroup
the highlight group used for highlighting the identifier’s new name
default: Substitute
Type: null or string
Default: null
Declared by:
plugins.inc-rename.inputBufferType
the type of the external input buffer to use
default: null
Type: null or value “dressing” (singular enum)
Default: null
Declared by:
plugins.inc-rename.postHook
callback to run after renaming, receives the result table (from LSP handler) as an argument
default: null
Type: null or string
Default: null
Declared by:
plugins.inc-rename.previewEmptyName
whether an empty new name should be previewed; if false the command preview will be cancelled instead
default: false
Type: null or boolean
Default: null
Declared by:
plugins.inc-rename.showMessage
whether to display a Renamed m instances in n files message after a rename operation
default: true
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.enable
Whether to enable indent-blankline.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.indent-blankline.package
Plugin to use for indent-blankline
Type: package
Default: <derivation vimplugin-indent-blankline.nvim-2023-07-07>
Declared by:
plugins.indent-blankline.bufnameExclude
Specifies a list of buffer names (file name with full path) for which this plugin is not enabled. A name can be regular expression as well.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.buftypeExclude
Specifies a list of |buftype| values for which this plugin is not enabled. Ignored if the value is an empty list.
default: ["terminal" "nofile" "quickfix" "prompt"]
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.char
Specifies the character to be used as indent line. Not used if charList is not empty.
When set explicitly to empty string (“”), no indentation character is displayed at all, even when ‘charList’ is not empty. This can be useful in combination with spaceCharHighlightList to only rely on different highlighting of different indentation levels without needing to show a special character.
default: │
Type: null or string
Default: null
Declared by:
plugins.indent-blankline.charBlankline
Specifies the character to be used as indent line for blanklines. Not used if charListBlankline is not empty.
default: ``
Type: null or string
Default: null
Declared by:
plugins.indent-blankline.charHighlightList
Specifies the list of character highlights for each indentation level. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.charList
Specifies a list of characters to be used as indent line for each indentation level. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.charListBlankline
Specifies a list of characters to be used as indent line for each indentation level on blanklines. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.charPriority
Specifies the |extmarks| priority for chars.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.indent-blankline.contextChar
Specifies the character to be used for the current context indent line. Not used if contextCharList is not empty.
Useful to have a greater distinction between the current context indent line and others.
Also useful in combination with char set to empty string (“”), as this allows only the current context indent line to be shown.
default: ``
Type: null or string
Default: null
Declared by:
plugins.indent-blankline.contextCharBlankline
Equivalent of charBlankline for contextChar.
default: ``
Type: null or string
Default: null
Declared by:
plugins.indent-blankline.contextCharList
Equivalent of charList for contextChar.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.contextCharListBlankline
Equivalent of charListBlankline for contextChar.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.contextHighlightList
Specifies the list of character highlights for the current context at each indentation level. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.contextPatternHighlight
Specifies a map of patterns set in contextPatterns to highlight groups. When the current matching context pattern is in the map, the context will be highlighted with the corresponding highlight group.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.indent-blankline.contextPatterns
Specifies a list of lua patterns that are used to match against the treesitter |tsnode:type()| at the cursor position to find the current context.
To learn more about how lua pattern work, see here: https://www.lua.org/manual/5.1/manual.html#5.4.1
default: [ "class" "^func" "method" "^if" "while" "for" "with" "try" "except" "arguments" "argument_list" "object" "dictionary" "element" "table" "tuple" "do_block" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.contextStartPriority
Specifies the |extmarks| priority for the context start.
default: 10000
Type: null or signed integer
Default: null
Declared by:
plugins.indent-blankline.disableWarningMessage
Turns deprecation warning messages off.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.disableWithNolist
When true, automatically turns this plugin off when |nolist| is set. When false, setting |nolist| will keep displaying indentation guides but removes whitespace characters set by |listchars|.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.extraOptions
Extra configuration options for indent-blankline without the ‘indent_blankline_’ prefix. Example: To set ‘indent_blankline_foobar’ to 1, write extraConfig = { foobar = true; };
Type: attribute set
Default: { }
Declared by:
plugins.indent-blankline.filetype
Specifies a list of |filetype| values for which this plugin is enabled. All |filetypes| are enabled if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.filetypeExclude
Specifies a list of |filetype| values for which this plugin is not enabled. Ignored if the value is an empty list.
default: ["lspinfo" "packer" "checkhealth" "help" "man" ""]
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.indentLevel
Specifies the maximum indent level to display.
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.indent-blankline.maxIndentIncrease
The maximum indent level increase from line to line. Set this option to 1 to make aligned trailing multiline comments not create indentation.
default: ``
Type: null or signed integer
Default: null
Declared by:
plugins.indent-blankline.showCurrentContext
When on, use treesitter to determine the current context. Then show the indent character in a different highlight.
Note: Requires https://github.com/nvim-treesitter/nvim-treesitter to be installed
Note: With this option enabled, the plugin refreshes on |CursorMoved|, which might be slower
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showCurrentContextStart
Applies the |hl-IndentBlanklineContextStart| highlight group to the first line of the current context. By default this will underline.
Note: Requires https://github.com/nvim-treesitter/nvim-treesitter to be installed
Note: You need to have set |gui-colors| and it depends on your terminal emulator if this works as expected. If you are using kitty and tmux, take a look at this article to make it work http://evantravers.com/articles/2021/02/05/curly-underlines-in-kitty-tmux-neovim/
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showCurrentContextStartOnCurrentLine
Shows showCurrentContextStart even when the cursor is on the same line
default: true
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showEndOfLine
Displays the end of line character set by |listchars| instead of the indent guide on line returns.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showFirstIndentLevel
Displays indentation in the first column.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showFoldtext
Displays the full fold text instead of the indent guide on folded lines.
Note: there is no autocommand to subscribe to changes in folding. This might lead to unexpected results. A possible solution for this is to remap folding bindings to also call |IndentBlanklineRefresh|
default: true
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.showTrailingBlanklineIndent
Displays a trailing indentation guide on blank lines, to match the indentation of surrounding code. Turn this off if you want to use background highlighting instead of chars.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.spaceCharBlankline
Specifies the character to be used as the space value in between indent lines when the line is blank.
default:
Type: null or string
Default: null
Declared by:
plugins.indent-blankline.spaceCharBlanklineHighlightList
Specifies the list of space character highlights for each indentation level when the line is empty. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.spaceCharHighlightList
Specifies the list of space character highlights for each indentation level. Ignored if the value is an empty list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.indent-blankline.strictTabs
When on, if there is a single tab in a line, only tabs are used to calculate the indentation level. When off, both spaces and tabs are used to calculate the indentation level. Only makes a difference if a line has a mix of tabs and spaces for indentation.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.useTreesitter
Use treesitter to calculate indentation when possible.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.useTreesitterScope
Instead of using contextPatters use the current scope defined by nvim-treesitter as the context
default: false
Type: null or boolean
Default: null
Declared by:
plugins.indent-blankline.viewportBuffer
Sets the buffer of extra lines before and after the current viewport that are considered when generating indentation and the context.
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.intellitab.enable
Whether to enable intellitab.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.intellitab.package
Plugin to use for intellitab.nvim
Type: package
Default: <derivation vimplugin-intellitab.nvim-2021-11-13>
Declared by:
plugins.julia-cell.enable
Whether to enable julia-cell.
Type: boolean
Default: false
Example: true
Declared by:
plugins.julia-cell.package
Plugin to use for julia-cell
Type: package
Default: <derivation vimplugin-vim-julia-cell-2020-08-04>
Declared by:
plugins.julia-cell.delimitCellsBy
Specifies if cells are delimited by ‘marks’ or ‘tags’.
default: "marks"
Type: null or one of “marks”, “tags”
Default: null
Declared by:
plugins.julia-cell.extraConfig
The configuration options for julia-cell without the ‘julia_cell_’ prefix. Example: To set ‘julia_cell_foobar’ to 1, write extraConfig = { foobar = true; };
Type: attribute set
Default: { }
Declared by:
plugins.julia-cell.keymaps.clear
Keymap for clearing the REPL.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.executeCell
Keymap for executing the current code cell.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.executeCellJump
Keymap for executing the current code cell and jumping to the next cell.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.nextCell
Keymap for jumping to the next cell header.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.prevCell
Keymap for jumping to the previous cell header.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.run
Keymap for running the entire file.
Type: null or string
Default: null
Declared by:
plugins.julia-cell.keymaps.silent
Whether julia-cell keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.julia-cell.tag
Specifies the tag format.
default: ##
Type: null or string
Default: null
Declared by:
plugins.lastplace.enable
Whether to enable lastplace.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lastplace.package
Plugin to use for lastplace
Type: package
Default: <derivation vimplugin-nvim-lastplace-2023-06-05>
Declared by:
plugins.lastplace.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.lastplace.ignoreBuftype
The list of buffer types to ignore by lastplace.
default: ["quickfix" "nofix" "help"]
Type: null or (list of string)
Default: null
Declared by:
plugins.lastplace.ignoreFiletype
The list of file types to ignore by lastplace.
default: ["gitcommit" "gitrebase" "svn" "hgcommit"]
Type: null or (list of string)
Default: null
Declared by:
plugins.lastplace.openFolds
Whether closed folds are automatically opened when jumping to the last edit position.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.leap.enable
Whether to enable leap.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.leap.package
Plugin to use for leap.nvim
Type: package
Default: <derivation vimplugin-leap.nvim-2023-07-04>
Declared by:
plugins.leap.addDefaultMappings
Whether to enable the default mappings.
Type: boolean
Default: true
Declared by:
plugins.leap.caseSensitive
Whether to consider case in search patterns.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.leap.equivalenceClasses
A character will match any other in its equivalence class. The sets can either be defined as strings or tables.
Example:
[
"\r\n"
")]}>"
"([{<"
[ "\"" "'" "`" ]
]
Note: Make sure to have a set containing \n if you want to be able to target characters at the end of the line.
Note: Non-mutual aliases are not possible in Leap, for the same reason that supporting |smartcase| is not possible: we would need to show two different labels, corresponding to two different futures, at the same time.
default: [" \t\r\n"]
Type: null or (list of (string or list of string))
Default: null
Declared by:
plugins.leap.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.leap.highlightUnlabeledPhaseOneTargets
Whether to highlight unlabeled (i.e., directly reachable) matches after the first input character.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.leap.labels
Target labels to be used when there are more matches than labels in |leap.opts.safe_labels| plus one.
Setting the list to [] forces autojump to always be on (except for Operator-pending mode, where it makes no sense). In this case, do not forget to set special_keys.next_group to something “safe” too.
default: [ "s" "f" "n" "j" "k" "l" "h" "o" "d" "w" "e" "m" "b" "u" "y" "v" "r" "g" "t" "c" "x" "/" "z" "S" "F" "N" "J" "K" "L" "H" "O" "D" "W" "E" "M" "B" "U" "Y" "V" "R" "G" "T" "C" "X" "?" "Z" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.leap.maxHighlightedTraversalTargets
Number of targets to be highlighted after the cursor in |leap-traversal| mode (when there are no labels at all).
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.leap.maxPhaseOneTargets
By default, the plugin shows labels and/or highlights matches right after the first input character. This option disables ahead-of-time displaying of target beacons beyond a certain number of phase one targets (to mitigate visual noise in extreme cases). Setting it to 0 disables two-phase processing altogether.
Type: null or signed integer
Default: null
Declared by:
plugins.leap.safeLabels
When the number of matches does not exceed the number of these “safe” labels plus one, the plugin jumps to the first match automatically after entering the pattern. Obviously, for this purpose you should choose keys that are unlikely to be used right after a jump!
Setting the list to [] effectively disables the autojump feature.
Note: Operator-pending mode ignores this, since we need to be able to select the actual target before executing the operation.
default: ["s" "f" "n" "u" "t" "/" "S" "F" "N" "L" "H" "M" "U" "G" "T" "?" "Z"]
Type: null or (list of string)
Default: null
Declared by:
plugins.leap.specialKeys.multiAccept
Key captured by the plugin at runtime to accept the selection in |leap-multiselect| mode.
default: <enter>
Type: null or string
Default: null
Declared by:
plugins.leap.specialKeys.multiRevert
Key captured by the plugin at runtime to deselect the last selected target in |leap-multiselect| mode.
default: <backspace>
Type: null or string
Default: null
Declared by:
plugins.leap.specialKeys.nextGroup
Key captured by the plugin at runtime to switch to the next group of matches, when there are more matches than available labels.
default: <space>
Type: null or string
Default: null
Declared by:
plugins.leap.specialKeys.nextTarget
Key captured by the plugin at runtime to jump to the next match in traversal mode (|leap-traversal|)
default: <enter>
Type: null or string
Default: null
Declared by:
plugins.leap.specialKeys.prevGroup
Key captured by the plugin at runtime to switch to the previous group of matches, when there are more matches than available labels.
default: <tab>
Type: null or string
Default: null
Declared by:
plugins.leap.specialKeys.prevTarget
Key captured by the plugin at runtime to jump to the previous match in traversal mode (|leap-traversal|)
default: <tab>
Type: null or string
Default: null
Declared by:
plugins.leap.substituteChars
The keys in this attrs will be substituted in labels and highlighted matches by the given characters. This way special (e.g. whitespace) characters can be made visible in matches, or even be used as labels.
Example: {"\r" = "¬";}
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.ledger.enable
Whether to enable ledger language features.
Type: boolean
Default: false
Example: true
Declared by:
plugins.ledger.package
Plugin to use for ledger
Type: package
Default: <derivation vimplugin-vim-ledger-2023-02-23>
Declared by:
plugins.ledger.detailedFirst
Account completion sorted by depth instead of alphabetically
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.ledger.fillString
String used to fill the space between account name and amount in the foldtext
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.ledger.foldBlanks
Hide blank lines following a transaction on a fold
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.ledger.maxWidth
Number of columns to display foldtext
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.lightline.enable
Whether to enable lightline.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lightline.package
Plugin to use for lightline
Type: package
Default: <derivation vimplugin-lightline.vim-2022-10-05>
Declared by:
plugins.lightline.active
This option has no description.
Type: null or (submodule)
Default: null
Declared by:
plugins.lightline.active.left
List of components that will show up on the left side of the bar
Type: null or (list of list of string)
Default: null
Declared by:
plugins.lightline.active.right
List of components that will show up on the right side of the bar
Type: null or (list of list of string)
Default: null
Declared by:
plugins.lightline.colorscheme
The colorscheme to use for lightline. Defaults to .colorscheme.
Type: null or string
Default: null
Example: "gruvbox"
Declared by:
plugins.lightline.component
Lightline component definitions. Uses ‘statusline’ syntax. Consult :h ‘statusline’ for a list of what’s available.
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lightline.componentFunction
A list of function component definitions.
You should define the functions themselves in extraConfig
Type: null or (attribute set of string)
Default: null
Example:
''
plugins.lightline = {
enable = true;
componentFunction = {
readonly = "LightlineReadonly";
};
extraConfig = '''
function! LightlineReadonly()
return &readonly && &filetype !=# 'help' ? 'RO' : '''
endfunction
''';
};
''
Declared by:
plugins.lightline.modeMap
Mode name mappings
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lsp.enable
Whether to enable neovim’s built-in LSP.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.enabledServers
A list of enabled LSP servers. Don’t use this directly.
Type: list of (string or (submodule))
Default: [ ]
Declared by:
plugins.lsp.capabilities
Lua code that modifies inplace the capabilities table.
Type: strings concatenated with “\n”
Default: ""
Declared by:
plugins.lsp.keymaps.diagnostic
Mappings for vim.diagnostic.<action> functions.
Type: attribute set of string
Default: { }
Example:
{
"<leader>j" = "goto_next";
"<leader>k" = "goto_prev";
}
Declared by:
plugins.lsp.keymaps.lspBuf
Mappings for vim.lsp.buf.<action> functions.
Type: attribute set of string
Default: { }
Example:
{
K = "hover";
gD = "references";
gd = "definition";
gi = "implementation";
gt = "type_definition";
}
Declared by:
plugins.lsp.keymaps.silent
Whether nvim-lsp keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.lsp.onAttach
A lua function to be run when a new LSP buffer is attached. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Default: ""
Declared by:
plugins.lsp.postConfig
Code to be run after loading the LSP. This is an internal option
Type: strings concatenated with “\n”
Default: ""
Declared by:
plugins.lsp.preConfig
Code to be run before loading the LSP. Useful for requiring plugins
Type: strings concatenated with “\n”
Default: ""
Declared by:
plugins.lsp.servers.astro.enable
Whether to enable Enable astrols, for Astro.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.astro.package
This option has no description.
Type: package
Default: <derivation _at_astrojs_slash_language-server-2.0.17>
Declared by:
plugins.lsp.servers.astro.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.astro.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/ppifx2w53pa9hi07klbjx5v4nwxxkhw8-_at_astrojs_slash_language-server-2.0.17/bin/astro-ls" "--stdio" ]
Declared by:
plugins.lsp.servers.astro.extraOptions
Extra options for the astro language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.astro.extraSettings
Extra settings for the astro language server.
Type: attribute set
Declared by:
plugins.lsp.servers.astro.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.astro.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.astro.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.astro.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.astro.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.astro.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.bashls.enable
Whether to enable Enable bashls, for bash…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.bashls.package
This option has no description.
Type: package
Default: <derivation bash-language-server-4.10.1>
Declared by:
plugins.lsp.servers.bashls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.bashls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.bashls.extraOptions
Extra options for the bashls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.bashls.extraSettings
Extra settings for the bashls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.bashls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.bashls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.bashls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.bashls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.bashls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.bashls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ccls.enable
Whether to enable Enable ccls, for C/C++…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.ccls.package
This option has no description.
Type: package
Default: <derivation ccls-0.20220729>
Declared by:
plugins.lsp.servers.ccls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.extraOptions
Extra options for the ccls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.ccls.extraSettings
Extra settings for the ccls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.ccls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.cache.directory
If your project is /a/b, cache directories will be created at /a/b/.ccls-cache/@a@b/ (files under the project root) /a/b/.ccls-cache/@@a@b/ (files outside the project root, e.g. /usr/include/stdio.h).
If the path name is longer than the system limit, set cache.hierarchicalPath to true. The cache files will be stored in a hierarchical manner: /a/b/.ccls-cache/a/b/. Be careful if you specify an absolute path as files indexed by different projects may conflict.
This can also be an absolute path. Because the project path is encoded with @, cache directories of different projects will not conflict.
When ccls is started, it will try loading cache files if they are not stale (compile command line matches and timestamps of main source and its #include (direct and transitive) dependencies do not change).
If the argument is an empty string, the cache will be stored only in memory. Use this if you don’t want to write cache files.
Example: "/tmp/ccls-cache"
default: .ccls-cache
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.cache.format
Specify the format of the cached index files. Binary is a compact binary serialization format.
If you would like to inspect the contents of the cache you can change this to "json" then use a JSON formatter such as jq . < /tmp/ccls/@tmp@c/a.cc.json to display it.
default: binary
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.cache.retainInMemory
Change to 0 if you want to save memory, but having multiple ccls processes operating in the same directory may corrupt ccls’s in-memory representation of the index.
After this number of loads, keep a copy of file index in memory (which increases memory usage). During incremental updates, the removed file index will be taken from the in-memory copy, instead of the on-disk file.
Every index action is counted: the initial load, a save action.
-
0: never retain
-
1: retain after initial load
-
2: retain after 2 loads (initial load+first save)
default: "1"
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.clang.excludeArgs
Excluded arguments for compile_commands.json entries.
If your compiler is not Clang and it supports arguments which Clang doesn’t understand, then you can remove those arguments when indexing.
Example: ["-frounding-math"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.clang.extraArgs
Additional arguments for compile_commands.json entries.
Example: ["-frounding-math"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.clang.pathMappings
A list of src>dest path conversions used to remap the paths of files in the project. This can be used to move a project to a new location without re-indexing.
If cache files were built with project root /tmp/remote/proj, and you want to reuse them with a different project root /tmp/host/proj then copy the cache:
rsync -a /tmp/ccls/@tmp@remote@proj/ /tmp/ccls/@tmp@host@proj/ # files under project root rsync -a /tmp/ccls/@@tmp@remote@proj/ /tmp/ccls/@@tmp@host@proj/ # files outside of project root
Then set this option to ["/remote/>/host/"].
When ccls indexes /tmp/host/proj/a.cc, the cache file /tmp/ccls/@tmp@remote@proj/a.cc.blob will be reused. When a.cc is saved (re-indexed), the newly generated a.cc.blob will not contain /tmp/remote paths any more.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.clang.resourceDir
The clang resource directory (something like .../lib/clang/9.0.0) is hard-coded into ccls at compile time. You should be able to find <resourceDir>/include/stddef.h. Set this option to a non-empty string to override the hard-coded value.
Use the path provided as the Clang resource directory rather the default.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.client.snippetSupport
client.snippetSupport and completion.placeholder (default: true) decide the completion style.
-
client.snippetSupport:false=>foo -
client.snippetSupport:true-
completion.placeholder:false=>foo($1)$0bar<$1>()$0 -
completion.placeholder:true=>foo($\{1:int a}, ${2:int b})$0
-
If the client announces that it does not support snippets, client.snippetSupport will be forced to false.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.compilationDatabaseDirectory
If not empty, look for compile_commands.json in it, otherwise the file is retrieved in the project root.
Useful when using out-of-tree builds with the compilation database being generated in the build directory.
Example: "out/release"
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.completion.detailedLabel
When this option is enabled, label and detailed are re-purposed:
-
label: detailed function signature, e.g.foo(int a, int b) -> bool -
detailed: the name of the parent context, e.g. inS s; s.<complete>, the parent context isS.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.completion.filterAndSort
ccls filters and sorts completions to try to be nicer to clients that can’t handle big numbers of completion candidates. This behaviour can be disabled by specifying false for the option.
This option is useful for LSP clients that implement their own filtering and sorting logic.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.completion.placeholder
client.snippetSupport and completion.placeholder (default: true) decide the completion style.
-
client.snippetSupport:false=>foo -
client.snippetSupport:true-
completion.placeholder:false=>foo($1)$0bar<$1>()$0 -
completion.placeholder:true=>foo($\{1:int a}, ${2:int b})$0
-
If the client announces that it does not support snippets, client.snippetSupport will be forced to false.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.diagnostics.onChange
Time (in milliseconds) to wait before computing diagnostics for textDocument/didChange. After receiving a textDocument/didChange, wait up to this long before reporting diagnostics. Changes during this period of time only lead to one computation.
Diagnostics require parsing the file. If 1000 makes you feel slow, consider setting this to 1.
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.diagnostics.onOpen
Time (in milliseconds) to wait before computing diagnostics for textDocument/didOpen. How long to wait before diagnostics are emitted when a document is opened.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.diagnostics.onSave
Time (in milliseconds) to wait before computing diagnostics for textDocument/didSave. How long to wait before diagnostics are emitted after a document is saved.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.comments
ccls can index the contents of comments associated with functions/types/variables (macros are not handled). This value controls how comments are indexed:
-
0: don’t index comments -
1: index Doxygen comment markers -
2: use-fparse-all-commentsand recognize plain///* */in addition to Doxygen comment markers
default: "2"
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.initialBlacklist
A list of regular expressions matching files that should not be indexed when the ccls server starts up, but will still be indexed if a client opens them. If there are areas of the project that you have no interest in indexing you can use this to avoid it unless you visit those files.
This can also be set to match all files, which is helpful in avoiding massive parsing operations when performing quick edits on large projects.
Be aware that you will not have access to full cross-referencing information in this situation.
If index.initialWhitelist is also specified, the whitelist takes precedence.
Example: ["."] (matches all files)
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.multiVersion
Index a file only once (0), or in each translation unit that includes it (1).
The default is sensible for common usage: it reduces memory footprint. If both a.cc and b.cc include a.h, there is only one indexed version of a.h.
But for dependent name lookup, or references in headers that may change depending on other macros, etc, you may want to index a file multiple times to get every possible cross reference. In that case set the option to 1 but be aware that it may increase index file sizes significantly.
Also consider using index.multiVersionBlacklist to exclude system headers.
default: "0"
Type: null or one of 0, 1
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.multiVersionBlacklist
A list of regular expressions matching files that should not be indexed via multi-version if index.multiVersion is set to 1.
Commonly this is used to avoid indexing system headers multiple times as this is seldom useful.
Example: ["^/usr/include"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.onChange
If false, a file is re-indexed when saved, updating the global index incrementally.
If set to true, a document is re-indexed for every (unsaved) change. Performance may suffer, but it is convenient for playground projects. Generally this is best used in conjunction with empty cache.directory to avoid writing cache files to disk.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.threads
How many threads to start when indexing a project. 0 means use std::thread::hardware_concurrency() (the number of cores the system has). If you want to reduce peak CPU and memory usage, set it to a small integer.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ccls.initOptions.index.trackDependency
Determine whether a file should be re-indexed when any of its dependencies changes timestamp.
If a.h has been changed, when you open a.cc which includes a.h then if trackDependency is:
-
0: no re-indexing unless
a.ccitself changes timestamp. -
2: the index of
a.ccis considered stale and it should be re-indexed. -
1: before the initial load, the behavior of
2is used, otherwise the behavior of0is used.
default: "2"
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.lsp.servers.ccls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.ccls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.ccls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.ccls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.ccls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.clangd.enable
Whether to enable Enable clangd LSP, for C/C++…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.clangd.package
This option has no description.
Type: package
Default: <derivation clang-tools-14.0.6>
Declared by:
plugins.lsp.servers.clangd.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.clangd.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.clangd.extraOptions
Extra options for the clangd language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.clangd.extraSettings
Extra settings for the clangd language server.
Type: attribute set
Declared by:
plugins.lsp.servers.clangd.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.clangd.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.clangd.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.clangd.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.clangd.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.clangd.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.clojure-lsp.enable
Whether to enable Enable clojure-lsp, for clojure…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.clojure-lsp.package
This option has no description.
Type: package
Default: <derivation clojure-lsp-2023.07.01-22.35.41>
Declared by:
plugins.lsp.servers.clojure-lsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.clojure-lsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.clojure-lsp.extraOptions
Extra options for the clojure-lsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.clojure-lsp.extraSettings
Extra settings for the clojure-lsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.clojure-lsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.clojure-lsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.clojure-lsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.clojure-lsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.clojure-lsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.clojure-lsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.cmake.enable
Whether to enable Enable cmake language server, for cmake files…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.cmake.package
This option has no description.
Type: package
Default: <derivation cmake-language-server-0.1.7>
Declared by:
plugins.lsp.servers.cmake.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.cmake.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.cmake.extraOptions
Extra options for the cmake language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.cmake.extraSettings
Extra settings for the cmake language server.
Type: attribute set
Declared by:
plugins.lsp.servers.cmake.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.cmake.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.cmake.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.cmake.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.cmake.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.cmake.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.csharp-ls.enable
Whether to enable Enable csharp-ls, for C#…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.csharp-ls.package
This option has no description.
Type: package
Default: <derivation csharp-ls-0.8.0>
Declared by:
plugins.lsp.servers.csharp-ls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.csharp-ls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.csharp-ls.extraOptions
Extra options for the csharp-ls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.csharp-ls.extraSettings
Extra settings for the csharp-ls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.csharp-ls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.csharp-ls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.csharp-ls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.csharp-ls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.csharp-ls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.csharp-ls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.cssls.enable
Whether to enable Enable cssls, for CSS.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.cssls.package
This option has no description.
Type: package
Default: <derivation vscode-langservers-extracted-4.7.0>
Declared by:
plugins.lsp.servers.cssls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.cssls.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/mmwjp5sqanxm03scm26xjkzywnjfg1lr-vscode-langservers-extracted-4.7.0/bin/vscode-css-language-server" "--stdio" ]
Declared by:
plugins.lsp.servers.cssls.extraOptions
Extra options for the cssls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.cssls.extraSettings
Extra settings for the cssls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.cssls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.cssls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.cssls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.cssls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.cssls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.cssls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.dartls.enable
Whether to enable Enable dart language-server, for dart.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.dartls.package
This option has no description.
Type: package
Default: <derivation dart-3.0.5>
Declared by:
plugins.lsp.servers.dartls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.dartls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.dartls.extraOptions
Extra options for the dartls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.dartls.extraSettings
Extra settings for the dartls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.dartls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.dartls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.dartls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.dartls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.dartls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.dartls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.enableSdkFormatter
When set to false, prevents registration (or unregisters) the SDK formatter. When set to true or not supplied, will register/reregister the SDK formatter
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.enableSnippets
Whether to include code snippets (such as class, stful, switch) in code completion. When unspecified, snippets will be included.
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.analysisExcludedFolders
An array of paths (absolute or relative to each workspace folder) that should be excluded from analysis.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.completeFunctionCalls
When set to true, completes functions/methods with their required parameters.
Type: null or boolean
Default: true
Declared by:
plugins.lsp.servers.dartls.settings.documentation
The typekind of dartdocs to include in Hovers, Code Completion, Signature Help and other similar requests. If not set, defaults to full
Type: null or one of “none”, “summary”, “full”
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.includeDependenciesInWorkspaceSymbols
Whether to include symbols from dependencies and Dart/Flutter SDKs in Workspace Symbol results. If not set, defaults to true.
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.lineLength
The number of characters the formatter should wrap code at. If unspecified, code will be wrapped at 80 characters.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.renameFilesWithClasses
When set to “always”, will include edits to rename files when classes are renamed if the filename matches the class name (but in snake_form). When set to “prompt”, a prompt will be shown on each class rename asking to confirm the file rename. Otherwise, files will not be renamed. Renames are performed using LSP’s ResourceOperation edits - that means the rename is simply included in the resulting WorkspaceEdit and must be handled by the client.
Type: null or one of “always”, “prompt”
Default: null
Declared by:
plugins.lsp.servers.dartls.settings.showTodos
Whether to generate diagnostics for TODO comments. If unspecified, diagnostics will not be generated.
Type: null or boolean
Default: true
Declared by:
plugins.lsp.servers.dartls.settings.updateImportsOnRename
Whether to update imports and other directives when files are renamed. When unspecified, imports will be updated if the client supports willRenameFiles requests
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.denols.enable
Whether to enable Enable denols, for Deno.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.denols.package
This option has no description.
Type: package
Default: <derivation deno-1.35.0>
Declared by:
plugins.lsp.servers.denols.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.denols.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.denols.extraOptions
Extra options for the denols language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.denols.extraSettings
Extra settings for the denols language server.
Type: attribute set
Declared by:
plugins.lsp.servers.denols.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.denols.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.denols.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.denols.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.denols.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.denols.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.elixirls.enable
Whether to enable Enable elixirls.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.elixirls.package
This option has no description.
Type: package
Default: <derivation elixir-ls-0.15.1>
Declared by:
plugins.lsp.servers.elixirls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.elixirls.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/3bw80iypxbjq3cbv4bqrxr0d3kdz66jl-elixir-ls-0.15.1/bin/elixir-ls" ]
Declared by:
plugins.lsp.servers.elixirls.extraOptions
Extra options for the elixirls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.elixirls.extraSettings
Extra settings for the elixirls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.elixirls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.elixirls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.elixirls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.elixirls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.elixirls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.elixirls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.elmls.enable
Whether to enable Enable elmls, for Elm…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.elmls.package
This option has no description.
Type: package
Default: <derivation _at_elm-tooling_slash_elm-language-server-2.7.0>
Declared by:
plugins.lsp.servers.elmls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.elmls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.elmls.extraOptions
Extra options for the elmls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.elmls.extraSettings
Extra settings for the elmls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.elmls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.elmls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.elmls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.elmls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.elmls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.elmls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.eslint.enable
Whether to enable Enable eslint.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.eslint.package
This option has no description.
Type: package
Default: <derivation vscode-langservers-extracted-4.7.0>
Declared by:
plugins.lsp.servers.eslint.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.eslint.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/mmwjp5sqanxm03scm26xjkzywnjfg1lr-vscode-langservers-extracted-4.7.0/bin/vscode-eslint-language-server" "--stdio" ]
Declared by:
plugins.lsp.servers.eslint.extraOptions
Extra options for the eslint language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.eslint.extraSettings
Extra settings for the eslint language server.
Type: attribute set
Declared by:
plugins.lsp.servers.eslint.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.eslint.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.eslint.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.eslint.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.eslint.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.eslint.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.futhark-lsp.enable
Whether to enable Enable Futhark lsp, for Futhark.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.futhark-lsp.package
This option has no description.
Type: package
Default: <derivation futhark-0.24.3>
Declared by:
plugins.lsp.servers.futhark-lsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.futhark-lsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.futhark-lsp.extraOptions
Extra options for the futhark-lsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.futhark-lsp.extraSettings
Extra settings for the futhark-lsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.futhark-lsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.futhark-lsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.futhark-lsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.futhark-lsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.futhark-lsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.futhark-lsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.gdscript.enable
Whether to enable Enable gdscript, for Godot.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.gdscript.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.gdscript.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.gdscript.extraOptions
Extra options for the gdscript language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.gdscript.extraSettings
Extra settings for the gdscript language server.
Type: attribute set
Declared by:
plugins.lsp.servers.gdscript.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.gdscript.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.gdscript.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.gdscript.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.gdscript.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.gdscript.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.gopls.enable
Whether to enable Enable gopls, for Go…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.gopls.package
This option has no description.
Type: package
Default: <derivation gopls-0.12.4>
Declared by:
plugins.lsp.servers.gopls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.gopls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.gopls.extraOptions
Extra options for the gopls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.gopls.extraSettings
Extra settings for the gopls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.gopls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.gopls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.gopls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.gopls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.gopls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.gopls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.hls.enable
Whether to enable Enable haskell language server.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.hls.package
This option has no description.
Type: package
Default: <derivation haskell-language-server-2.0.0.0>
Declared by:
plugins.lsp.servers.hls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.hls.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "haskell-language-server-wrapper" ]
Declared by:
plugins.lsp.servers.hls.extraOptions
Extra options for the hls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.hls.extraSettings
Extra settings for the hls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.hls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.hls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.hls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.hls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.hls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.hls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.html.enable
Whether to enable Enable html, for HTML.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.html.package
This option has no description.
Type: package
Default: <derivation vscode-langservers-extracted-4.7.0>
Declared by:
plugins.lsp.servers.html.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.html.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/mmwjp5sqanxm03scm26xjkzywnjfg1lr-vscode-langservers-extracted-4.7.0/bin/vscode-html-language-server" "--stdio" ]
Declared by:
plugins.lsp.servers.html.extraOptions
Extra options for the html language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.html.extraSettings
Extra settings for the html language server.
Type: attribute set
Declared by:
plugins.lsp.servers.html.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.html.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.html.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.html.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.html.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.html.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.java-language-server.enable
Whether to enable Enable java language server.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.java-language-server.package
This option has no description.
Type: package
Default: <derivation java-language-server-0.2.38>
Declared by:
plugins.lsp.servers.java-language-server.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.java-language-server.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/qjcslg92j568jm3wh8pfw6i91zz4phad-java-language-server-0.2.38/bin/java-language-server" ]
Declared by:
plugins.lsp.servers.java-language-server.extraOptions
Extra options for the java-language-server language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.java-language-server.extraSettings
Extra settings for the java-language-server language server.
Type: attribute set
Declared by:
plugins.lsp.servers.java-language-server.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.java-language-server.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.java-language-server.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.java-language-server.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.java-language-server.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.java-language-server.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.jsonls.enable
Whether to enable Enable jsonls, for JSON.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.jsonls.package
This option has no description.
Type: package
Default: <derivation vscode-langservers-extracted-4.7.0>
Declared by:
plugins.lsp.servers.jsonls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.jsonls.cmd
This option has no description.
Type: null or (list of string)
Default:
[ "/nix/store/mmwjp5sqanxm03scm26xjkzywnjfg1lr-vscode-langservers-extracted-4.7.0/bin/vscode-json-language-server" "--stdio" ]
Declared by:
plugins.lsp.servers.jsonls.extraOptions
Extra options for the jsonls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.jsonls.extraSettings
Extra settings for the jsonls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.jsonls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.jsonls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.jsonls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.jsonls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.jsonls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.jsonls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.julials.enable
Whether to enable Enable julials, for Julia.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.julials.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.julials.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.julials.extraOptions
Extra options for the julials language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.julials.extraSettings
Extra settings for the julials language server.
Type: attribute set
Declared by:
plugins.lsp.servers.julials.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.julials.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.julials.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.julials.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.julials.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.julials.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.kotlin-language-server.enable
Whether to enable Enable kotlin language server.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.kotlin-language-server.package
This option has no description.
Type: package
Default: <derivation kotlin-language-server-1.3.3>
Declared by:
plugins.lsp.servers.kotlin-language-server.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.kotlin-language-server.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.kotlin-language-server.extraOptions
Extra options for the kotlin-language-server language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.kotlin-language-server.extraSettings
Extra settings for the kotlin-language-server language server.
Type: attribute set
Declared by:
plugins.lsp.servers.kotlin-language-server.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.kotlin-language-server.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.kotlin-language-server.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.kotlin-language-server.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.kotlin-language-server.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.kotlin-language-server.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.enable
Whether to enable Enable ltex-ls, for LanguageTool.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.ltex.package
This option has no description.
Type: package
Default: <derivation ltex-ls-16.0.0>
Declared by:
plugins.lsp.servers.ltex.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ltex.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.extraOptions
Extra options for the ltex language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.ltex.extraSettings
Extra settings for the ltex language server.
Type: attribute set
Declared by:
plugins.lsp.servers.ltex.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.ltex.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.ltex.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.ltex.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.ltex.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.enabled
Controls whether the extension is enabled. Allows disabling LanguageTool on specific workspaces or for specific code language modes (i.e., file types).
Either supply a boolean value stating whether LTEX is enabled for all supported markup languages or disabled for all of them, or supply a list of code language identifiers for which LTEX should be enabled (note that extensions can define additional code language identifiers).
All supported markup languages are listed in the default value of this setting. In addition, LTEX can check comments in many popular programming languages like C++ or Java, if you add the corresponding code language identifiers to this setting. If you add an unsupported code language mode, LTEX will check corresponding files as plain text without any parsing.
The activation events are unaffected by this setting. This means that the extension will be activated whenever a file with a supported code language mode is opened. For unsupported code language modes, you may need to activate the extension explicitly by executing the LTeX: Activate Extension command.
Examples:
-
true
-
false
-
[“latex” “markdown”]
default: ["bibtex" "context" "context.tex" "html" "latex" "markdown" "org" "restructuredtext" "rsweave"]
Type: null or boolean or list of string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.enabledRules
Lists of rules that should be enabled (if disabled by default by LanguageTool). This setting is language-specific, so use an attrs of the format
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
...
};
where <LANGUAGE> denotes the language code in settings.language and <RULE> the ID of the LanguageTool rule.
This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional rules will be enabled.
Example:
{
"en-GB" = [
"PASSIVE_VOICE"
"OXFORD_SPELLING_NOUNS"
":/path/to/externalFile.txt"
];
}
default: {}
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.additionalRules.enablePickyRules
Enable LanguageTool rules that are marked as picky and that are disabled by default, e.g., rules about passive voice, sentence length, etc., at the cost of more false positives.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.additionalRules.languageModel
Optional path to a directory with rules of a language model with n-gram occurrence counts. Set this setting to the parent directory that contains subdirectories for languages (e.g., en).
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.additionalRules.motherTongue
Optional mother tongue of the user (e.g., “de-DE”).
If set, additional rules will be checked to detect false friends. Picky rules may need to be enabled in order to see an effect (see settings.additionalRules.enablePickyRules). False friend detection improves if a language model is supplied (see settings.additionalRules.languageModel).
Possible values:
-
“”: No mother tongue
-
“ar”: Arabic
-
“ast-ES”: Asturian
-
“be-BY”: Belarusian
-
“br-FR”: Breton
-
“ca-ES”: Catalan
-
“ca-ES-valencia”: Catalan (Valencian)
-
“da-DK”: Danish
-
“de”: German
-
“de-AT”: German (Austria)
-
“de-CH”: German (Swiss)
-
“de-DE”: German (Germany)
-
“de-DE-x-simple-language”: Simple German
-
“el-GR”: Greek
-
“en”: English
-
“en-AU”: English (Australian)
-
“en-CA”: English (Canadian)
-
“en-GB”: English (GB)
-
“en-NZ”: English (New Zealand)
-
“en-US”: English (US)
-
“en-ZA”: English (South African)
-
“eo”: Esperanto
-
“es”: Spanish
-
“es-AR”: Spanish (voseo)
-
“fa”: Persian
-
“fr”: French
-
“ga-IE”: Irish
-
“gl-ES”: Galician
-
“it”: Italian
-
“ja-JP”: Japanese
-
“km-KH”: Khmer
-
“nl”: Dutch
-
“nl-BE”: Dutch (Belgium)
-
“pl-PL”: Polish
-
“pt”: Portuguese
-
“pt-AO”: Portuguese (Angola preAO)
-
“pt-BR”: Portuguese (Brazil)
-
“pt-MZ”: Portuguese (Moçambique preAO)
-
“pt-PT”: Portuguese (Portugal)
-
“ro-RO”: Romanian
-
“ru-RU”: Russian
-
“sk-SK”: Slovak
-
“sl-SI”: Slovenian
-
“sv”: Swedish
-
“ta-IN”: Tamil
-
“tl-PH”: Tagalog
-
“uk-UA”: Ukrainian
-
“zh-CN”: Chinese
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.additionalRules.neuralNetworkModel
Optional path to a directory with rules of a pretrained neural network model.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.additionalRules.word2VecModel
Optional path to a directory with rules of a word2vec language model.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.checkFrequency
Controls when documents should be checked.
Possible values:
-
“edit”: Documents are checked when they are opened or edited (on every keystroke), or when the settings change.
-
“save”: Documents are checked when they are opened or saved, or when the settings change.
-
“manual”: Documents are not checked automatically, except when the settings change. Use commands such as LTeX: Check Current Document to manually trigger checks.
default: "edit"
Type: null or one of “edit”, “save”, “manual”
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.clearDiagnosticsWhenClosingFile
If set to true, diagnostics of a file are cleared when the file is closed.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.completionEnabled
Controls whether completion is enabled (also known as auto-completion, quick suggestions, and IntelliSense).
If this setting is enabled, then a list of words is displayed that complete the currently typed word (whenever the editor sends a completion request).
In VS Code, completion is enabled by default while typing (via editor.quickSuggestions). Therefore, this setting is disabled by default, as constantly displaying completion lists might annoy the user. It is recommended to enable this setting.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.configurationTarget
Controls which settings.json or external setting file (see documentation) to update when using one of the quick fixes.
default: { dictionary = "workspaceFolderExternalFile"; disabledRules = "workspaceFolderExternalFile"; hiddenFalsePositives = "workspaceFolderExternalFile"; }
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.diagnosticSeverity
Severity of the diagnostics corresponding to the grammar and spelling errors.
Controls how and where the diagnostics appear. The possible severities are “error”, “warning”, “information”, and “hint”.
This setting can either be a string with the severity to use for all diagnostics, or an attrs with rule-dependent severities. If an attrs is used, each key is the ID of a LanguageTool rule and each value is one of the possible severities. In this case, the severity of other rules, which don’t match any of the keys, has to be specified with the special key “default”.
Examples:
-
"information" -
{PASSIVE_VOICE = "hint"; default = "information";}
default: information
Type: null or Concatenated string or attribute set of string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.dictionary
Lists of additional words that should not be counted as spelling errors. This setting is language-specific, so use an attrs of the format
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
...
};
where <LANGUAGE> denotes the language code in settings.language.
This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional spelling errors will be ignored.
Example:
{
"en-US" = [
"adaptivity"
"precomputed"
"subproblem"
];
"de-DE" = [
"B-Splines"
":/path/to/externalFile.txt"
];
}
default: {}
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.disabledRules
Lists of rules that should be disabled (if enabled by default by LanguageTool). This setting is language-specific, so use an attrs of the format
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
...
};
where <LANGUAGE> denotes the language code in settings.language and <RULE> the ID of the LanguageTool rule.
This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. By default, no additional rules will be disabled.
Example:
{
"en-US" = [
"EN_QUOTES"
"UPPERCASE_SENTENCE_START"
":/path/to/externalFile.txt"
];
}
default: {}
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.fields
List of BibTEX fields whose values are to be checked in BibTEX files.
This setting is an attrs with the field names as keys (not restricted to classical BibTEX fields) and booleans as values, where true means that the field value should be checked and false means that the field value should be ignored.
Some common fields are already ignored, even if you set this setting to an empty attrs.
Example:
{
maintitle = false;
seealso = true;
}
default: {}
Type: null or (attribute set of boolean)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.hiddenFalsePositives
Lists of false-positive diagnostics to hide (by hiding all diagnostics of a specific rule within a specific sentence). This setting is language-specific, so use an attrs of the format
{
"<LANGUAGE1>" = [
"<JSON1>"
"<JSON2>"
...
];
"<LANGUAGE2>" = [
"<JSON1>"
"<JSON2>"
];
...
};
where <LANGUAGE> denotes the language code in settings.language and <JSON> is a JSON string containing information about the rule and sentence.
Although it is possible to manually edit this setting, the intended way is the Hide false positive quick fix.
The JSON string currently has the form {"rule": "<RULE>", "sentence": "<SENTENCE>"}, where <RULE> is the ID of the LanguageTool rule and <SENTENCE> is a Java-compatible regular expression. All occurrences of the given rule are hidden in sentences (as determined by the LanguageTool tokenizer) that match the regular expression. See the documentation for details.
This setting is a multi-scope setting. See the documentation for details. This setting supports external files. See the documentation for details. If this list is very large, performance may suffer.
Example:
{
"en-US" = [ ":/path/to/externalFile.txt" ];
}
default: {}
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.java.initialHeapSize
Initial size of the Java heap memory in megabytes (corresponds to Java’s -Xms option, must be a positive integer).
Decreasing this might decrease RAM usage of the Java process.
Changes require restarting LTEX to take effect.
default: 64
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.java.maximumHeapSize
Maximum size of the Java heap memory in megabytes (corresponds to Java’s -Xmx option, must be a positive integer).
Decreasing this might decrease RAM usage of the Java process. If you set this too small, the Java process may exceed the heap size, in which case an OutOfMemoryError is thrown.
Changes require restarting LTEX to take effect.
default: 512
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.java.path
If set to an empty string, LTEX uses a Java distribution that is bundled with ltex-ls. You can point this setting to an existing Java installation on your computer to use that installation instead.
Use the same path as you would use for the JAVA_HOME environment variable (it usually contains bin and lib subdirectories, amongst others).
Changes require restarting LTEX to take effect.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.language
The language (e.g., “en-US”) LanguageTool should check against. Use a specific variant like “en-US” or “de-DE” instead of the generic language code like “en” or “de” to obtain spelling corrections (in addition to grammar corrections).
When using the language code “auto”, LTEX will try to detect the language of the document. This is not recommended, as only generic languages like “en” or “de” will be detected and thus no spelling errors will be reported.
Possible values:
-
“auto”: Automatic language detection (not recommended)
-
“ar”: Arabic
-
“ast-ES”: Asturian
-
“be-BY”: Belarusian
-
“br-FR”: Breton
-
“ca-ES”: Catalan
-
“ca-ES-valencia”: Catalan (Valencian)
-
“da-DK”: Danish
-
“de”: German
-
“de-AT”: German (Austria)
-
“de-CH”: German (Swiss)
-
“de-DE”: German (Germany)
-
“de-DE-x-simple-language”: Simple German
-
“el-GR”: Greek
-
“en”: English
-
“en-AU”: English (Australian)
-
“en-CA”: English (Canadian)
-
“en-GB”: English (GB)
-
“en-NZ”: English (New Zealand)
-
“en-US”: English (US)
-
“en-ZA”: English (South African)
-
“eo”: Esperanto
-
“es”: Spanish
-
“es-AR”: Spanish (voseo)
-
“fa”: Persian
-
“fr”: French
-
“ga-IE”: Irish
-
“gl-ES”: Galician
-
“it”: Italian
-
“ja-JP”: Japanese
-
“km-KH”: Khmer
-
“nl”: Dutch
-
“nl-BE”: Dutch (Belgium)
-
“pl-PL”: Polish
-
“pt”: Portuguese
-
“pt-AO”: Portuguese (Angola preAO)
-
“pt-BR”: Portuguese (Brazil)
-
“pt-MZ”: Portuguese (Moçambique preAO)
-
“pt-PT”: Portuguese (Portugal)
-
“ro-RO”: Romanian
-
“ru-RU”: Russian
-
“sk-SK”: Slovak
-
“sl-SI”: Slovenian
-
“sv”: Swedish
-
“ta-IN”: Tamil
-
“tl-PH”: Tagalog
-
“uk-UA”: Ukrainian
-
“zh-CN”: Chinese
default: en-US
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.languageToolHttpServerUri
If set to a non-empty string, LTEX will not use the bundled, built-in version of LanguageTool. Instead, LTEX will connect to an external LanguageTool HTTP server. Set this setting to the root URI of the server, and do not append v2/check or similar.
Note that in this mode, the settings settings.additionalRules.languageModel, settings.additionalRules.neuralNetworkModel, and settings.additionalRules.word2VecModel will not take any effect.
Example: "http://localhost:8081/";
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.languageToolOrg.apiKey
API key for Premium API access. Only relevant if settings.languageToolHttpServerUri is set.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.languageToolOrg.username
Username/email as used to log in at languagetool.org for Premium API access. Only relevant if settings.languageToolHttpServerUri is set.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.latex.commands
List of LATEX commands to be handled by the LATEX parser, listed together with empty arguments (e.g., "ref{}", "\documentclass[]{}").
This setting is an attrs with the commands as keys and corresponding actions as values.
If you edit the settings.json file directly, don’t forget to escape the initial backslash by replacing it with two backslashes.
Many common commands are already handled by default, even if you set this setting to an empty attrs.
Example:
{
"\\label{}" = "ignore";
"\\documentclass[]{}" = "ignore";
"\\cite{}" = "dummy";
"\\cite[]{}" = "dummy";
}
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.latex.environments
List of names of LATEX environments to be handled by the LATEX parser.
This setting is an attrs with the environment names as keys and corresponding actions as values.
Some environments are already handled by default, even if you set this setting to an empty attrs.
Example:
{
lstlisting = "ignore";
verbatim = "ignore";
}
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.ltex-ls.logLevel
Logging level (verbosity) of the ltex-ls server log.
The levels in descending order are “severe”, “warning”, “info”, “config”, “fine”, “finer”, and “finest”. All messages that have the specified log level or a higher level are logged.
ltex-ls does not use all log levels.
Possible values:
-
“severe”: Minimum verbosity. Only log severe errors.
-
“warning”: Very low verbosity. Only log severe errors and warnings.
-
“info”: Low verbosity. Additionally, log startup and shutdown messages.
-
“config”: Medium verbosity. Additionally, log configuration messages.
-
“fine”: Medium to high verbosity (default). Additionally, log when LanguageTool is called or LanguageTool has to be reinitialized due to changed settings.
-
“finer”: High verbosity. Log additional debugging information such as full texts to be checked.
-
“finest”: Maximum verbosity. Log all available debugging information.
default: "fine"
Type: null or one of “severe”, “warning”, “info”, “config”, “fine”, “finer”, “finest”
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.ltex-ls.path
If set to an empty string, LTEX automatically downloads ltex-ls from GitHub, stores it in the folder of the extension, and uses it for the checking process. You can point this setting to an ltex-ls release you downloaded by yourself.
Use the path to the root directory of ltex-ls (it contains bin and lib subdirectories).
Changes require restarting LTEX to take effect.
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.markdown.nodes
List of Markdown node types to be handled by the Markdown parser.
This setting is an attrs with the node types as keys and corresponding actions as values.
The Markdown parser constructs an AST (abstract syntax tree) for the Markdown document, in which all leaves have node type Text. The possible node types are listed in the documentation of flexmark-java.
Some common node types are already handled by default, even if you set this setting to an empty attrs.
Example:
{
CodeBlock = "ignore";
FencedCodeBlock = "ignore";
AutoLink = "dummy";
Code = "dummy";
}
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.sentenceCacheSize
Size of the LanguageTool ResultCache in sentences (must be a positive integer).
If only a small portion of the text changed (e.g., a single key press in the editor), LanguageTool uses the cache to avoid rechecking the complete text. LanguageTool internally splits the text into sentences, and sentences that have already been checked are skipped.
Decreasing this might decrease RAM usage of the Java process. If you set this too small, checking time may increase significantly.
Changes require restarting LTEX to take effect.
default: 2000
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.statusBarItem
If set to true, an item about the status of LTEX is shown permanently in the status bar.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ltex.settings.trace.server
Debug setting to log the communication between language client and server.
When reporting issues, set this to “verbose”. Append the relevant part to the GitHub issue.
Changes require restarting LTEX to take effect.
Possible values:
-
“off”: Don’t log any of the communication between language client and server.
-
“messages”: Log the type of requests and responses between language client and server.
-
“verbose”: Log the type and contents of requests and responses between language client and server.
default: "off"
Type: null or one of “off”, “messages”, “verbose”
Default: null
Declared by:
plugins.lsp.servers.lua-ls.enable
Whether to enable Enable lua LS, for lua.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.lua-ls.package
This option has no description.
Type: package
Default: <derivation lua-language-server-3.6.23>
Declared by:
plugins.lsp.servers.lua-ls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.lua-ls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.lua-ls.extraOptions
Extra options for the lua-ls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.lua-ls.extraSettings
Extra settings for the lua-ls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.lua-ls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.lua-ls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.lua-ls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.lua-ls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.lua-ls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.lua-ls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.lua-ls.settings.diagnostics.globals
An array of variable names that will be declared as global.
Type: null or (list of string)
Default:
[ "vim" ]
Declared by:
plugins.lsp.servers.lua-ls.settings.runtime.version
Tell the language server which version of Lua you’re using (most likely LuaJIT in the case of Neovim)
Type: null or string
Default: "LuaJIT"
Declared by:
plugins.lsp.servers.lua-ls.settings.telemetry.enable
Whether to enable telemetry.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.lua-ls.settings.workspace.checkThirdParty
Whether third party libraries can be automatically detected and applied. Third party libraries can set up the environment to be as close as possible to your target runtime environment.
Type: null or boolean
Default: false
Declared by:
plugins.lsp.servers.lua-ls.settings.workspace.library
An array of abosolute or workspace-relative paths that will be added to the workspace diagnosis - meaning you will get completion and context from these library files. Can be a file or directory. Files included here will have some features disabled such as renaming fields to prevent accidentally renaming your library files.
Type: null or string or (submodule)
Default:
{
__raw = "vim.api.nvim_get_runtime_file('', true)";
}
Declared by:
plugins.lsp.servers.metals.enable
Whether to enable Enable metals, for Scala.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.metals.package
This option has no description.
Type: package
Default: <derivation metals-0.11.12>
Declared by:
plugins.lsp.servers.metals.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.metals.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.metals.extraOptions
Extra options for the metals language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.metals.extraSettings
Extra settings for the metals language server.
Type: attribute set
Declared by:
plugins.lsp.servers.metals.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.metals.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.metals.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.metals.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.metals.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.metals.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.nil_ls.enable
Whether to enable Enable nil, for Nix.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.nil_ls.package
This option has no description.
Type: package
Default: <derivation nil-2023-05-09>
Declared by:
plugins.lsp.servers.nil_ls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.nil_ls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nil_ls.extraOptions
Extra options for the nil_ls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.nil_ls.extraSettings
Extra settings for the nil_ls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.nil_ls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nil_ls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.nil_ls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.nil_ls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.nil_ls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.nil_ls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.nil_ls.settings.diagnostics.excludedFiles
Files to exclude from showing diagnostics. Useful for generated files. It accepts an array of paths. Relative paths are joint to the workspace root. Glob patterns are currently not supported.
Type: list of string
Default: [ ]
Declared by:
plugins.lsp.servers.nil_ls.settings.diagnostics.ignored
Ignored diagnostic kinds. The kind identifier is a snake_cased_string usually shown together with the diagnostic message.
Type: list of string
Default: [ ]
Declared by:
plugins.lsp.servers.nil_ls.settings.formatting.command
External formatter command (with arguments). It should accepts file content in stdin and print the formatted code into stdout.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nixd.enable
Whether to enable Enable nixd, for Nix.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.nixd.package
This option has no description.
Type: package
Default: <derivation nixd-1.1.0>
Declared by:
plugins.lsp.servers.nixd.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.nixd.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nixd.extraOptions
Extra options for the nixd language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.nixd.extraSettings
Extra settings for the nixd language server.
Type: attribute set
Declared by:
plugins.lsp.servers.nixd.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nixd.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.nixd.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.nixd.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.nixd.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.nixd.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.eval.depth
Extra depth for evaluation
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.eval.target.args
Accept args as “nix eval”.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.eval.target.installable
“nix eval”
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.eval.workers
The number of workers for evaluation task.
default: 3
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.formatting.command
Which command you would like to do formatting
default: nixpkgs-fmt
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.options.enable
Enable option completion task. If you are writting a package, disable this
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.options.target.args
Accept args as “nix eval”.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.nixd.settings.options.target.installable
“nix eval”
default: ``
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.enable
Whether to enable Enable pylsp, for Python…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.pylsp.package
This option has no description.
Type: package
Default: <derivation python3.10-python-lsp-server-1.7.4>
Declared by:
plugins.lsp.servers.pylsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.extraOptions
Extra options for the pylsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.pylsp.extraSettings
Extra settings for the pylsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.pylsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.pylsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.pylsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.pylsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.configurationSources
List of configuration sources to use.
Type: null or one of “pycodestyle”, “flake8”
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.autopep8
autopep8 settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.autopep8.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (autopep8).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.black.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (python-lsp-black).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.black.cache_config
Whether to enable black configuration caching.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.black.line_length
An integer that maps to black’s max-line-length setting. Defaults to 88 (same as black’s default). This can also be set through black’s configuration files, which should be preferred for multi-user projects.
default: 88
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.black.preview
Enable or disable black’s --preview setting.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8
flake8 settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (flake8).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.config
Path to the config file that will be the authoritative config source.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.exclude
List of files or directories to exclude.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.executable
Path to the flake8 executable.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.filename
Only check for filenames matching the patterns in this list.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.hangClosing
Hang closing bracket instead of matching indentation of opening bracket’s line.
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.ignore
List of errors and warnings to ignore (or skip).
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.indentSize
Set indentation spaces.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.maxComplexity
Maximum allowed complexity threshold.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.maxLineLength
Maximum allowed line length for the entirety of this run.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.perFileIgnores
A pairing of filenames and violation codes that defines which violations to ignore in a particular file.
For example: ["file_path.py:W305,W304"].
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.flake8.select
List of errors and warnings to enable.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.isort.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pyls-isort).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi
jedi settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi.auto_import_modules
List of module names for jedi.settings.auto_import_modules.
default: [ "numpy" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi.environment
Define environment for jedi.Script and Jedi.names.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi.extra_paths
Define extra paths for jedi.Script.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion
jedi_completion settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.cache_for
Modules for which labels and snippets should be cached.
default: [ "pandas" "numpy" "tensorflow" "matplotlib" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.eager
Resolve documentation and detail eagerly.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.fuzzy
Enable fuzzy when requesting autocomplete.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_class_objects
Adds class objects as a separate completion item.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_function_objects
Adds function objects as a separate completion item.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.include_params
Auto-completes methods and classes with tabstops for each parameter.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_completion.resolve_at_most
How many labels and snippets (at most) should be resolved.
default: 25
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_definition
jedi_definition settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_builtin_definitions
Follow builtin and extension definitions to stubs.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_builtin_imports
If follow_imports is true will decide if it follow builtin imports.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_definition.follow_imports
The goto call will follow imports.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_hover
jedi_hover settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_hover.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_references
jedi_references settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_references.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_signature_help
jedi_signature_help settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_signature_help.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols
jedi_symbols settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.all_scopes
If true lists the names of all scopes instead of only the module namespace.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.jedi_symbols.include_import_symbols
If true includes symbols imported from other libraries.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.mccabe
mccabe settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.mccabe.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (mccabe).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.mccabe.threshold
The minimum threshold that triggers warnings about cyclomatic complexity.
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.memestra.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pyls-memestra).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.preload
preload settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.preload.enabled
Enable or disable the plugin.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.preload.modules
List of modules to import on startup.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle
pycodestyle settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pycodestyle).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.exclude
Exclude files or directories which match these patterns.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.filename
When parsing directories, only check filenames matching these patterns.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.hangClosing
Hang closing bracket instead of matching indentation of opening bracket’s line.
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.ignore
Ignore errors and warnings.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.indentSize
Set indentation spaces.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.maxLineLength
Set maximum allowed line length.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pycodestyle.ropeFolder
Select errors and warnings.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle
pydocstyle settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pydocstyle).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.addIgnore
Ignore errors and warnings in addition to the specified convention.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.addSelect
Select errors and warnings in addition to the specified convention.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.convention
Choose the basic list of checked errors by specifying an existing convention.
Type: null or one of “pep257”, “numpy”, “google”, “None”
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.ignore
Ignore errors and warnings.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.match
Check only files that exactly match the given regular expression; default is to match files that don’t start with ‘test_’ but end with ‘.py’.
default: (?!test_).*\.py
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.matchDir
Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot.
default: [^\.].*
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pydocstyle.select
Select errors and warnings.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pyflakes
pyflakes settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pyflakes.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pyflakes).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylint
pylint settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylint.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pylint).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylint.args
Arguments to pass to pylint.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylint.executable
Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy
pylsp_mypy settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pylsp-mypy).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.config_sub_paths
Specifies sub paths under which the mypy configuration file may be found. For each directory searched for the mypy config file, this also searches the sub paths specified here.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.dmypy
Executes via dmypy run rather than mypy. This uses the dmypy daemon and may dramatically improve the responsiveness of the pylsp server, however this currently does not work in live_mode. Enabling this disables live_mode, even for conflicting configs.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.dmypy_status_file
Specifies which status file dmypy should use. This modifies the --status-file option passed to dmypy given dmypy is active.
default: .dmypy.json
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.live_mode
Provides type checking as you type. This writes to a tempfile every time a check is done. Turning off live_mode means you must save your changes for mypy diagnostics to update correctly.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.overrides
Specifies a list of alternate or supplemental command-line options. This modifies the options passed to mypy or the mypy-specific ones passed to dmypy run. When present, the special boolean member true is replaced with the command-line options that would’ve been passed had overrides not been specified. Later options take precedence, which allows for replacing or negating individual default options (see mypy.main:process_options and mypy --help | grep inverse).
default: [true]
Type: null or (list of (boolean or string))
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.report_progress
Report basic progress to the LSP client. With this option, pylsp-mypy will report when mypy is running, given your editor supports LSP progress reporting. For small files this might produce annoying flashing in your editor, especially in with live_mode. For large projects, enabling this can be helpful to assure yourself whether mypy is still running.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.pylsp_mypy.strict
Refers to the strict option of mypy. This option often is too strict to be useful.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (pylsp-rope).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_autoimport
rope_autoimport settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_autoimport.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (rope).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_autoimport.memory
Make the autoimport database memory only. Drastically increases startup time.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_completion
rope_completion settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_completion.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (rope).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.rope_completion.eager
Resolve documentation and detail eagerly.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (python-lsp-ruff).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.config
Path to optional pyproject.toml file.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.exclude
Exclude files from being checked by ruff.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.executable
Path to the ruff executable. Assumed to be in PATH by default.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.extendIgnore
Same as ignore, but append to existing ignores.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.extendSelect
Same as select, but append to existing error codes.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.format
List of error codes to fix during formatting. The default is [“I”], any additional codes are appended to this list.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.ignore
Error codes to ignore.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.lineLength
Set the line-length for length checks.
Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.perFileIgnores
File-specific error codes to be ignored.
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.ruff.select
List of error codes to enable.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.yapf
yapf settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.plugins.yapf.enabled
Enable or disable the plugin. Setting this explicitely to true will install the dependency for this plugin (yapf).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.rope
rope settings
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.rope.extensionModules
Builtin and c-extension modules that are allowed to be imported and inspected by rope.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.pylsp.settings.rope.ropeFolder
The name of the folder in which rope stores project configurations and data. Pass null for not using such a folder at all.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pyright.enable
Whether to enable Enable pyright, for Python…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.pyright.package
This option has no description.
Type: package
Default: <derivation pyright-1.1.316>
Declared by:
plugins.lsp.servers.pyright.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.pyright.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pyright.extraOptions
Extra options for the pyright language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.pyright.extraSettings
Extra settings for the pyright language server.
Type: attribute set
Declared by:
plugins.lsp.servers.pyright.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.pyright.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.pyright.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.pyright.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.pyright.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.pyright.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.rnix-lsp.enable
Whether to enable Enable rnix LSP, for Nix.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.rnix-lsp.package
This option has no description.
Type: package
Default: <derivation rnix-lsp-unstable-2022-11-27>
Declared by:
plugins.lsp.servers.rnix-lsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rnix-lsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rnix-lsp.extraOptions
Extra options for the rnix-lsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.rnix-lsp.extraSettings
Extra settings for the rnix-lsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.rnix-lsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rnix-lsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.rnix-lsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.rnix-lsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.rnix-lsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.rnix-lsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.ruff-lsp.enable
Whether to enable Enable ruff-lsp, for Python…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.ruff-lsp.package
This option has no description.
Type: package
Default: <derivation python3.10-ruff-lsp-0.0.35>
Declared by:
plugins.lsp.servers.ruff-lsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.ruff-lsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ruff-lsp.extraOptions
Extra options for the ruff-lsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.ruff-lsp.extraSettings
Extra settings for the ruff-lsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.ruff-lsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.ruff-lsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.ruff-lsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.ruff-lsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.ruff-lsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.ruff-lsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.enable
Whether to enable Enable rust-analyzer, for Rust…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.rust-analyzer.package
This option has no description.
Type: package
Default: <derivation rust-analyzer-2023-07-03>
Declared by:
plugins.lsp.servers.rust-analyzer.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.extraOptions
Extra options for the rust-analyzer language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.rust-analyzer.extraSettings
Extra settings for the rust-analyzer language server.
Type: attribute set
Declared by:
plugins.lsp.servers.rust-analyzer.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.rust-analyzer.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.rust-analyzer.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.rust-analyzer.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.assist.emitMustUse
Whether to insert #[must_use] when generating as_ methods for enum variants.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.assist.expressionFillDefault
Placeholder expression to use for missing expressions in assists.
default value is:
"todo"Type: null or one of “todo”, “default”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cachePriming.enable
Warm up caches on project load.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cachePriming.numThreads
How many worker threads to handle priming caches. The default 0 means to pick automatically.
default value is:
0Type: null or integer or floating point number between 0 and 255 (both inclusive)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.autoreload
Automatically refresh project info via cargo metadata on Cargo.toml or .cargo/config.toml changes.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.enable
Run build scripts (build.rs) for more precise code analysis.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.invocationLocation
Specifies the working directory for running build scripts.
-
“workspace”: run build scripts for a workspace in the workspace’s root directory. This is incompatible with
rust-analyzer.cargo.buildScripts.invocationStrategyset toonce. -
“root”: run build scripts in the project’s root directory. This config only has an effect when
rust-analyzer.cargo.buildScripts.overrideCommandis set.
default value is:
"workspace"Type: null or one of “workspace”, “root”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.invocationStrategy
Specifies the invocation strategy to use when running the build scripts command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when rust-analyzer.cargo.buildScripts.overrideCommand is set.
default value is:
"per_workspace"Type: null or one of “per_workspace”, “once”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.overrideCommand
Override the command rust-analyzer uses to run build scripts and build procedural macros. The command is required to output json and should therefore include --message-format=json or a similar option.
By default, a cargo invocation will be constructed for the configured targets and features, with the following base command line:
cargo check --quiet --workspace --message-format=json --all-targets.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.buildScripts.useRustcWrapper
Use RUSTC_WRAPPER=rust-analyzer when running build scripts to avoid checking unnecessary things.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.extraEnv
Extra environment variables that will be set when running cargo, rustc or other commands within the workspace. Useful for setting RUSTFLAGS.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.features
List of features to activate.
Set this to "all" to pass --all-features to cargo.
default value is:
[]Type: null or value “all” (singular enum) or list of string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.noDefaultFeatures
Whether to pass --no-default-features to cargo.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.sysroot
Relative path to the sysroot, or “discover” to try to automatically find it via “rustc --print sysroot”.
Unsetting this disables sysroot loading.
This option does not take effect until rust-analyzer is restarted.
default value is:
"discover"Type: null or null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.target
Compilation target override (target triple).
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.cargo.unsetTest
Unsets #[cfg(test)] for the specified crates.
default value is:
["core"]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.allTargets
Check all targets and tests (--all-targets).
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.command
Cargo command to use for cargo check.
default value is:
"check"Type: null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.extraArgs
Extra arguments for cargo check.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.extraEnv
Extra environment variables that will be set when running cargo check. Extends rust-analyzer.cargo.extraEnv.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.features
List of features to activate. Defaults to rust-analyzer.cargo.features.
Set to "all" to pass --all-features to Cargo.
default value is:
nullType: null or null or value “all” (singular enum) or list of string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.invocationLocation
Specifies the working directory for running checks.
-
“workspace”: run checks for workspaces in the corresponding workspaces’ root directories. This falls back to “root” if
rust-analyzer.cargo.checkOnSave.invocationStrategyis set toonce. -
“root”: run checks in the project’s root directory. This config only has an effect when
rust-analyzer.cargo.buildScripts.overrideCommandis set.
default value is:
"workspace"Type: null or one of “workspace”, “root”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.invocationStrategy
Specifies the invocation strategy to use when running the checkOnSave command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when rust-analyzer.cargo.buildScripts.overrideCommand is set.
default value is:
"per_workspace"Type: null or one of “per_workspace”, “once”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.noDefaultFeatures
Whether to pass --no-default-features to Cargo. Defaults to rust-analyzer.cargo.noDefaultFeatures.
default value is:
nullType: null or null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.overrideCommand
Override the command rust-analyzer uses instead of cargo check for diagnostics on save. The command is required to output json and should therefore include --message-format=json or a similar option (if your client supports the colorDiagnosticOutput experimental capability, you can use --message-format=json-diagnostic-rendered-ansi).
If you’re changing this because you’re using some tool wrapping Cargo, you might also want to change rust-analyzer.cargo.buildScripts.overrideCommand.
If there are multiple linked projects, this command is invoked for each of them, with the working directory being the project root (i.e., the folder containing the Cargo.toml).
An example command would be:
cargo check --workspace --message-format=json --all-targets.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.check.targets
Check for specific targets. Defaults to rust-analyzer.cargo.target if empty.
Can be a single target, e.g. "x86_64-unknown-linux-gnu" or a list of targets, e.g. ["aarch64-apple-darwin", "x86_64-apple-darwin"].
Aliased as "checkOnSave.targets".
default value is:
nullType: null or null or string or list of string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.checkOnSave
Run the check command for diagnostics on save.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.autoimport.enable
Toggles the additional completions that automatically add imports when completed. Note that your client must specify the additionalTextEdits LSP client capability to truly have this feature enabled.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.autoself.enable
Toggles the additional completions that automatically show method calls and field accesses with self prefixed to them when inside a method.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.callable.snippets
Whether to add parenthesis and argument snippets when completing function.
default value is:
"fill_arguments"Type: null or one of “fill_arguments”, “add_parentheses”, “none”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.postfix.enable
Whether to show postfix snippets like dbg, if, not, etc.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.privateEditable.enable
Enables completions of private items and fields that are defined in the current workspace even if they are not visible at the current position.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.completion.snippets.custom
Custom completion snippets.
default value is:
{"Arc::new" = {"postfix" = "arc";
"body" = "Arc::new($\{receiver})";
"requires" = "std::sync::Arc";
"description" = "Put the expression into an `Arc`";
"scope" = "expr";
};
"Rc::new" = {"postfix" = "rc";
"body" = "Rc::new($\{receiver})";
"requires" = "std::rc::Rc";
"description" = "Put the expression into an `Rc`";
"scope" = "expr";
};
"Box::pin" = {"postfix" = "pinbox";
"body" = "Box::pin($\{receiver})";
"requires" = "std::boxed::Box";
"description" = "Put the expression into a pinned `Box`";
"scope" = "expr";
};
"Ok" = {"postfix" = "ok";
"body" = "Ok($\{receiver})";
"description" = "Wrap the expression in a `Result::Ok`";
"scope" = "expr";
};
"Err" = {"postfix" = "err";
"body" = "Err($\{receiver})";
"description" = "Wrap the expression in a `Result::Err`";
"scope" = "expr";
};
"Some" = {"postfix" = "some";
"body" = "Some($\{receiver})";
"description" = "Wrap the expression in an `Option::Some`";
"scope" = "expr";
};
}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.enable
Whether to show native rust-analyzer diagnostics.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.disabled
List of rust-analyzer diagnostics to disable.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.experimental.enable
Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.remapPrefix
Map of prefixes to be substituted when parsing diagnostic file paths. This should be the reverse mapping of what is passed to rustc as --remap-path-prefix.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.warningsAsHint
List of warnings that should be displayed with hint severity.
The warnings will be indicated by faded text or three dots in code and will not show up in the Problems Panel.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.diagnostics.warningsAsInfo
List of warnings that should be displayed with info severity.
The warnings will be indicated by a blue squiggly underline in code and a blue icon in the Problems Panel.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.files.excludeDirs
These directories will be ignored by rust-analyzer. They are relative to the workspace root, and globs are not supported. You may also need to add the folders to Code’s files.watcherExclude.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.files.watcher
Controls file watching implementation.
default value is:
"client"Type: null or one of “client”, “server”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.highlightRelated.breakPoints.enable
Enables highlighting of related references while the cursor is on break, loop, while, or for keywords.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.highlightRelated.exitPoints.enable
Enables highlighting of all exit points while the cursor is on any return, ?, fn, or return type arrow (->).
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.highlightRelated.references.enable
Enables highlighting of related references while the cursor is on any identifier.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.highlightRelated.yieldPoints.enable
Enables highlighting of all break points for a loop or block context while the cursor is on any async or await keywords.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.enable
Whether to show HoverActions in Rust files.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.debug.enable
Whether to show Debug action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.gotoTypeDef.enable
Whether to show Go to Type Definition action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.implementations.enable
Whether to show Implementations action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.references.enable
Whether to show References action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.actions.run.enable
Whether to show Run action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.documentation.enable
Whether to show documentation on hover.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.documentation.keywords.enable
Whether to show keyword hover popups. Only applies when rust-analyzer.hover.documentation.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.hover.links.enable
Use markdown syntax for links in hover.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.granularity.enforce
Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.granularity.group
How imports should be grouped into use statements.
default value is:
"crate"Type: null or one of “preserve”, “crate”, “module”, “item”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.group.enable
Group inserted imports by the following order. Groups are separated by newlines.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.merge.glob
Whether to allow import insertion to merge new imports into single path glob imports like use std::fmt::*;.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.prefer.no.std
Prefer to unconditionally use imports of the core and alloc crate, over the std crate.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.imports.prefix
The path structure for newly inserted paths to use.
default value is:
"plain"Type: null or one of “plain”, “self”, “crate”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.bindingModeHints.enable
Whether to show inlay type hints for binding modes.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.chainingHints.enable
Whether to show inlay type hints for method chains.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.closingBraceHints.enable
Whether to show inlay hints after a closing } to indicate what item it belongs to.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.closingBraceHints.minLines
Minimum number of lines required before the } until the hint is shown (set to 0 or 1 to always show them).
default value is:
25Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.closureReturnTypeHints.enable
Whether to show inlay type hints for return types of closures.
default value is:
"never"Type: null or one of “always”, “never”, “with_block”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.discriminantHints.enable
Whether to show enum variant discriminant hints.
default value is:
"never"Type: null or one of “always”, “never”, “fieldless”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.enable
Whether to show inlay hints for type adjustments.
default value is:
"never"Type: null or one of “always”, “never”, “reborrow”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe
Whether to hide inlay hints for type adjustments outside of unsafe blocks.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.expressionAdjustmentHints.mode
Whether to show inlay hints as postfix ops (.* instead of *, etc).
default value is:
"prefix"Type: null or one of “prefix”, “postfix”, “prefer_prefix”, “prefer_postfix”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.lifetimeElisionHints.enable
Whether to show inlay type hints for elided lifetimes in function signatures.
default value is:
"never"Type: null or one of “always”, “never”, “skip_trivial”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.lifetimeElisionHints.useParameterNames
Whether to prefer using parameter names as the name for elided lifetime hints if possible.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.maxLength
Maximum length for inlay hints. Set to null to have an unlimited length.
default value is:
25Type: null or null or signed integer
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.parameterHints.enable
Whether to show function parameter name inlay hints at the call site.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.reborrowHints.enable
Whether to show inlay hints for compiler inserted reborrows. This setting is deprecated in favor of rust-analyzer.inlayHints.expressionAdjustmentHints.enable.
default value is:
"never"Type: null or one of “always”, “never”, “mutable”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.renderColons
Whether to render leading colons for type hints, and trailing colons for parameter hints.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.enable
Whether to show inlay type hints for variables.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.hideClosureInitialization
Whether to hide inlay type hints for let statements that initialize to a closure. Only applies to closures with blocks, same as rust-analyzer.inlayHints.closureReturnTypeHints.enable.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.inlayHints.typeHints.hideNamedConstructor
Whether to hide inlay type hints for constructors.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.joinLines.joinAssignments
Join lines merges consecutive declaration and initialization of an assignment.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.joinLines.joinElseIf
Join lines inserts else between consecutive ifs.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.joinLines.removeTrailingComma
Join lines removes trailing commas.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.joinLines.unwrapTrivialBlock
Join lines unwraps trivial blocks.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.enable
Whether to show CodeLens in Rust files.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.debug.enable
Whether to show Debug lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.forceCustomCommands
Internal config: use custom client-side commands even when the client doesn’t set the corresponding capability.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.implementations.enable
Whether to show Implementations lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.location
Where to render annotations.
default value is:
"above_name"Type: null or one of “above_name”, “above_whole_item”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.references.adt.enable
Whether to show References lens for Struct, Enum, and Union. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.references.enumVariant.enable
Whether to show References lens for Enum Variants. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.references.method.enable
Whether to show Method References lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.references.trait.enable
Whether to show References lens for Trait. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lens.run.enable
Whether to show Run lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.linkedProjects
Disable project auto-discovery in favor of explicitly specified set of projects.
Elements must be paths pointing to Cargo.toml, rust-project.json, or JSON objects in rust-project.json format.
default value is:
[]Type: null or (list of (string or attribute set of anything))
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.lru.capacity
Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
default value is:
nullType: null or null or signed integer
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.notifications.cargoTomlNotFound
Whether to show can't find Cargo.toml error message.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.numThreads
How many worker threads in the main loop. The default null means to pick automatically.
default value is:
nullType: null or null or signed integer
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.procMacro.enable
Enable support for procedural macros, implies rust-analyzer.cargo.buildScripts.enable.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.procMacro.attributes.enable
Expand attribute macros. Requires rust-analyzer.procMacro.enable to be set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.procMacro.ignored
These proc-macros will be ignored when trying to expand them.
This config takes a map of crate names with the exported proc-macro names to ignore as values.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.procMacro.server
Internal config, path to proc-macro server executable (typically, this is rust-analyzer itself, but we override this in tests).
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.references.excludeImports
Exclude imports from find-all-references.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.runnables.command
Command to be executed instead of ‘cargo’ for runnables.
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.runnables.extraArgs
Additional arguments to be passed to cargo for runnables such as tests or binaries. For example, it may be --release.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.rustc.source
Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or “discover” to try to automatically find it if the rustc-dev component is installed.
Any project which uses rust-analyzer with the rustcPrivate crates must set [package.metadata.rust-analyzer] rustc_private=true to use it.
This option does not take effect until rust-analyzer is restarted.
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.rustfmt.extraArgs
Additional arguments to rustfmt.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.rustfmt.overrideCommand
Advanced option, fully override the command rust-analyzer uses for formatting.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.rustfmt.rangeFormatting.enable
Enables the use of rustfmt’s unstable range formatting command for the textDocument/rangeFormatting request. The rustfmt option is unstable and only available on a nightly build.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.doc.comment.inject.enable
Inject additional highlighting into doc comments.
When enabled, rust-analyzer will highlight rust source in doc comments as well as intra doc links.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.operator.enable
Use semantic tokens for operators.
When disabled, rust-analyzer will emit semantic tokens only for operator tokens when they are tagged with modifiers.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.operator.specialization.enable
Use specialized semantic tokens for operators.
When enabled, rust-analyzer will emit special token types for operator tokens instead of the generic operator token type.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.enable
Use semantic tokens for punctuations.
When disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when they are tagged with modifiers or have a special role.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.separate.macro.bang
When enabled, rust-analyzer will emit a punctuation semantic token for the ! of macro calls.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.punctuation.specialization.enable
Use specialized semantic tokens for punctuations.
When enabled, rust-analyzer will emit special token types for punctuation tokens instead of the generic punctuation token type.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.semanticHighlighting.strings.enable
Use semantic tokens for strings.
In some editors (e.g. vscode) semantic tokens override other highlighting grammars. By disabling semantic tokens for strings, other grammars can be used to highlight their contents.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.signatureInfo.detail
Show full signature of the callable. Only shows parameters if disabled.
default value is:
"full"Type: null or one of “full”, “parameters”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.signatureInfo.documentation.enable
Show documentation.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.typing.autoClosingAngleBrackets.enable
Whether to insert closing angle brackets when typing an opening angle bracket of a generic argument list.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.kind
Workspace symbol search kind.
default value is:
"only_types"Type: null or one of “only_types”, “all_symbols”
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.limit
Limits the number of items returned from a workspace symbol search (Defaults to 128). Some clients like vs-code issue new searches on result filtering and don’t require all results to be returned in the initial search. Other clients requires all results upfront and might require a higher limit.
default value is:
128Type: null or signed integer
Default: null
Declared by:
plugins.lsp.servers.rust-analyzer.settings.workspace.symbol.search.scope
Workspace symbol search scope.
default value is:
"workspace"Type: null or one of “workspace”, “workspace_and_dependencies”
Default: null
Declared by:
plugins.lsp.servers.sourcekit.enable
Whether to enable Enable the sourcekit language server, for Swift and C/C++/Objective-C.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.sourcekit.package
This option has no description.
Type: package
Default: <derivation sourcekit-lsp-5.8>
Declared by:
plugins.lsp.servers.sourcekit.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.sourcekit.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.sourcekit.extraOptions
Extra options for the sourcekit language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.sourcekit.extraSettings
Extra settings for the sourcekit language server.
Type: attribute set
Declared by:
plugins.lsp.servers.sourcekit.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.sourcekit.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.sourcekit.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.sourcekit.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.sourcekit.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.sourcekit.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.tailwindcss.enable
Whether to enable Enable tailwindcss language server, for tailwindcss.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.tailwindcss.package
This option has no description.
Type: package
Default: <derivation _at_tailwindcss_slash_language-server-0.0.13>
Declared by:
plugins.lsp.servers.tailwindcss.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.tailwindcss.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.tailwindcss.extraOptions
Extra options for the tailwindcss language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.tailwindcss.extraSettings
Extra settings for the tailwindcss language server.
Type: attribute set
Declared by:
plugins.lsp.servers.tailwindcss.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.tailwindcss.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.tailwindcss.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.tailwindcss.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.tailwindcss.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.tailwindcss.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.terraformls.enable
Whether to enable Enable terraform-ls, for terraform.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.terraformls.package
This option has no description.
Type: package
Default: <derivation terraform-ls-0.31.3>
Declared by:
plugins.lsp.servers.terraformls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.terraformls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.terraformls.extraOptions
Extra options for the terraformls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.terraformls.extraSettings
Extra settings for the terraformls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.terraformls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.terraformls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.terraformls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.terraformls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.terraformls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.terraformls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.texlab.enable
Whether to enable Enable texlab language server, for LaTeX.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.texlab.package
This option has no description.
Type: package
Default: <derivation texlab-5.7.0>
Declared by:
plugins.lsp.servers.texlab.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.texlab.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.texlab.extraOptions
Extra options for the texlab language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.texlab.extraSettings
Extra settings for the texlab language server.
Type: attribute set
Declared by:
plugins.lsp.servers.texlab.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.texlab.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.texlab.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.texlab.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.texlab.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.texlab.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.tsserver.enable
Whether to enable Enable tsserver for typescript.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.tsserver.package
This option has no description.
Type: package
Default: <derivation typescript-language-server-3.3.2>
Declared by:
plugins.lsp.servers.tsserver.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.tsserver.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.tsserver.extraOptions
Extra options for the tsserver language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.tsserver.extraSettings
Extra settings for the tsserver language server.
Type: attribute set
Declared by:
plugins.lsp.servers.tsserver.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.tsserver.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.tsserver.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.tsserver.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.tsserver.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.tsserver.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.typst-lsp.enable
Whether to enable Enable typst-lsp for typst.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.typst-lsp.package
This option has no description.
Type: package
Default: <derivation typst-lsp-0.7.1>
Declared by:
plugins.lsp.servers.typst-lsp.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.typst-lsp.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.typst-lsp.extraOptions
Extra options for the typst-lsp language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.typst-lsp.extraSettings
Extra settings for the typst-lsp language server.
Type: attribute set
Declared by:
plugins.lsp.servers.typst-lsp.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.typst-lsp.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.typst-lsp.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.typst-lsp.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.typst-lsp.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.typst-lsp.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.vuels.enable
Whether to enable Enable vuels, for Vue.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.vuels.package
This option has no description.
Type: package
Default: <derivation vls-0.8.5>
Declared by:
plugins.lsp.servers.vuels.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.vuels.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.vuels.extraOptions
Extra options for the vuels language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.vuels.extraSettings
Extra settings for the vuels language server.
Type: attribute set
Declared by:
plugins.lsp.servers.vuels.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.vuels.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.vuels.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.vuels.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.vuels.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.vuels.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.yamlls.enable
Whether to enable Enable yamlls, for yaml.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.yamlls.package
This option has no description.
Type: package
Default: <derivation yaml-language-server-1.13.0>
Declared by:
plugins.lsp.servers.yamlls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.yamlls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.yamlls.extraOptions
Extra options for the yamlls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.yamlls.extraSettings
Extra settings for the yamlls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.yamlls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.yamlls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.yamlls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.yamlls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.yamlls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.yamlls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.servers.zls.enable
Whether to enable Enable zls, for Zig…
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp.servers.zls.package
This option has no description.
Type: package
Default: <derivation zls-0.10.0>
Declared by:
plugins.lsp.servers.zls.autostart
Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lsp.servers.zls.cmd
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.zls.extraOptions
Extra options for the zls language server.
Type: attribute set
Default: { }
Declared by:
plugins.lsp.servers.zls.extraSettings
Extra settings for the zls language server.
Type: attribute set
Declared by:
plugins.lsp.servers.zls.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp.servers.zls.installLanguageServer
Whether nixvim should take care of installing the language server.
Type: boolean
Default: true
Declared by:
plugins.lsp.servers.zls.onAttach
Server specific on_attach behavior.
Type: null or (submodule)
Default: null
Declared by:
plugins.lsp.servers.zls.onAttach.function
Body of the on_attach function. The argument client and bufnr is provided.
Type: strings concatenated with “\n”
Declared by:
plugins.lsp.servers.zls.onAttach.override
Override the global plugins.lsp.onAttach function.
Type: boolean
Default: false
Declared by:
plugins.lsp.servers.zls.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or string
Default: null
Declared by:
plugins.lsp.setupWrappers
Code to be run to wrap the setup args. Takes in an argument containing the previous results, and returns a new string of code.
Type: list of function that evaluates to a(n) string
Default: [ ]
Declared by:
plugins.lsp-format.enable
Whether to enable lsp-format.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp-format.package
Plugin to use for lsp-format.nvim
Type: package
Default: <derivation vimplugin-lsp-format.nvim-2022-11-25>
Declared by:
plugins.lsp-format.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.lsp-format.lspServersToEnable
Choose the LSP servers for which lsp-format should be enabled.
Possible values:
-
“all” (default): Enable formatting for all language servers
-
“none”: Do not enable formatting on any language server. You might choose this if for some reason you want to manually call
require("lsp-format").on_attach(client)in theonAttachfunction of your language servers. -
list of LS names: Manually choose the servers by name
Type: one of “none”, “all” or list of string
Default: "all"
Example:
[ "efm" "gopls" ]
Declared by:
plugins.lsp-format.setup
The setup option maps |filetypes| to format options.
Type: attribute set of (attribute set)
Default: { }
Example:
{
gopls = {
exclude = [
"gopls"
];
force = true;
order = [
"gopls"
"efm"
];
sync = true;
};
}
Declared by:
plugins.lsp-format.setup.<name>.exclude
List of client names to exclude from formatting.
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp-format.setup.<name>.force
If true, the format result will always be written to the buffer, even if the buffer changed.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp-format.setup.<name>.order
List of client names. Formatting is requested from clients in the following order: first all clients that are not in the order table, then the remaining clients in the order as they occur in the order table. (same logic as |vim.lsp.buf.formatting_seq_sync()|).
Type: null or (list of string)
Default: null
Declared by:
plugins.lsp-format.setup.<name>.sync
Whether to turn on synchronous formatting. The editor will block until formatting is done.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lsp-lines.enable
Whether to enable lsp_lines.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lsp-lines.package
Plugin to use for lsp_lines.nvim
Type: package
Default: <derivation vimplugin-lsp_lines.nvim-2023-05-15>
Declared by:
plugins.lsp-lines.currentLine
Show diagnostics only on current line
Type: boolean
Default: false
Declared by:
plugins.lspkind.enable
Whether to enable lspkind.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lspkind.package
Plugin to use for lspkind
Type: package
Default: <derivation vimplugin-lspkind-nvim-2023-05-05>
Declared by:
plugins.lspkind.cmp.enable
Integrate with nvim-cmp
Type: boolean
Default: true
Declared by:
plugins.lspkind.cmp.after
Function to run after calculating the formatting. function(entry, vim_item, kind)
Type: null or string
Default: null
Declared by:
plugins.lspkind.cmp.ellipsisChar
Character to show when the popup exceeds maxwidth
Type: null or string
Default: null
Declared by:
plugins.lspkind.cmp.maxWidth
Maximum number of characters to show in the popup
Type: null or signed integer
Default: null
Declared by:
plugins.lspkind.cmp.menu
Show source names in the popup
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lspkind.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.lspkind.mode
Defines how annotations are shown
default: "symbol_text"
Type: null or one of “text”, “text_symbol”, “symbol_text”, “symbol”
Default: null
Declared by:
plugins.lspkind.preset
Default symbol map
default: "codicons"
Type: null or one of “default”, “codicons”
Default: null
Declared by:
plugins.lspkind.symbolMap
Override preset symbols
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.lspsaga.enable
Whether to enable lspsaga.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lspsaga.package
Plugin to use for lspsaga
Type: package
Default: <derivation vimplugin-lspsaga.nvim-2022-12-06>
Declared by:
plugins.lspsaga.borderStyle
Border style
Type: null or one of “thin”, “rounded”, “thick”
Default: null
Declared by:
plugins.lspsaga.headers.error
Error diagnostic header
Type: null or string
Default: null
Declared by:
plugins.lspsaga.headers.hint
Hint diagnostic header
Type: null or string
Default: null
Declared by:
plugins.lspsaga.headers.info
Info diagnostic header
Type: null or string
Default: " Info"
Declared by:
plugins.lspsaga.headers.warning
Warning diagnostic header
Type: null or string
Default: null
Declared by:
plugins.lspsaga.icons.codeAction
Code action icon
Type: null or string
Default: null
Declared by:
plugins.lspsaga.icons.definitionPreview
Definition preview icon
Type: null or string
Default: null
Declared by:
plugins.lspsaga.icons.findDefinition
Find definition icon
Type: null or string
Default: null
Declared by:
plugins.lspsaga.icons.findReference
Find reference icon
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.codeAction.exec
Execute code action
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.codeAction.quit
Quit code actions menu
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.open
Open from finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.quit
Quit finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.scrollDown
Scroll down finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.scrollUp
Scroll up finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.split
Horizontal split in finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.keys.finderAction.vsplit
Vertical split in finder
Type: null or string
Default: null
Declared by:
plugins.lspsaga.maxDialogWidth
Maximum dialog width
Type: null or signed integer
Default: null
Declared by:
plugins.lspsaga.maxFinderPreviewLines
Maximum finder preview lines
Type: null or signed integer
Default: null
Declared by:
plugins.lspsaga.renamePromptPrefix
Rename prompt prefix
Type: null or string
Default: null
Declared by:
plugins.lspsaga.signs.error
Error diagnostic sign
Type: null or string
Default: null
Declared by:
plugins.lspsaga.signs.hint
Hint diagnostic sign
Type: null or string
Default: null
Declared by:
plugins.lspsaga.signs.info
Info diagnostic sign
Type: null or string
Default: null
Declared by:
plugins.lspsaga.signs.use
Whether to use diagnostic signs
Type: boolean
Default: true
Declared by:
plugins.lspsaga.signs.warning
Warning diagnostic sign
Type: null or string
Default: null
Declared by:
plugins.lualine.enable
Whether to enable lualine.
Type: boolean
Default: false
Example: true
Declared by:
plugins.lualine.package
Plugin to use for lualine
Type: package
Default: <derivation vimplugin-lualine.nvim-2023-05-04>
Declared by:
plugins.lualine.alwaysDivideMiddle
When set to true, left sections i.e. ‘a’,‘b’ and ‘c’ can’t take over the entire statusline even if neither of ‘x’, ‘y’ or ‘z’ are present.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.lualine.componentSeparators
component separtors.
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.componentSeparators.left
Left separator
default:
Type: null or string
Default: null
Declared by:
plugins.lualine.componentSeparators.right
Right separator
default:
Type: null or string
Default: null
Declared by:
plugins.lualine.disabledFiletypes
Filetypes to disable lualine for.
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.disabledFiletypes.statusline
Only ignores the ft for statusline.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lualine.disabledFiletypes.winbar
Only ignores the ft for winbar.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lualine.extensions
list of enabled extensions
Type: null or (list of string)
Default: null
Example: "[ \"fzf\" ]"
Declared by:
plugins.lualine.globalstatus
Enable global statusline (have a single statusline at bottom of neovim instead of one for every window). This feature is only available in neovim 0.7 and higher.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.lualine.iconsEnabled
Whether to enable/disable icons for all components.
Type: boolean
Default: true
Declared by:
plugins.lualine.ignoreFocus
If current filetype is in this list it’ll always be drawn as inactive statusline and the last window will be drawn as active statusline.
For example if you don’t want statusline of your file tree / sidebar window to have active statusline you can add their filetypes here.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.lualine.inactiveSections
Inactive Sections configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_a
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_b
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_c
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_x
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_y
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveSections.lualine_z
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar
Inactive Winbar configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_a
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_b
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_c
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_x
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_y
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.inactiveWinbar.lualine_z
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.refresh
Sets how often lualine should refresh it’s contents (in ms). The refresh option sets minimum time that lualine tries to maintain between refresh. It’s not guarantied if situation arises that lualine needs to refresh itself before this time it’ll do it.
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.refresh.statusline
Refresh time for the status line (ms)
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.lualine.refresh.tabline
Refresh time for the tabline (ms)
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.lualine.refresh.winbar
Refresh time for the winbar (ms)
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.lualine.sectionSeparators
section separtors.
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.sectionSeparators.left
Left separator
default:
Type: null or string
Default: null
Declared by:
plugins.lualine.sectionSeparators.right
Right separator
default:
Type: null or string
Default: null
Declared by:
plugins.lualine.sections
Sections configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.sections.lualine_a
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.sections.lualine_b
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.sections.lualine_c
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.sections.lualine_x
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.sections.lualine_y
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.sections.lualine_z
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline
Tabline configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.tabline.lualine_a
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline.lualine_b
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline.lualine_c
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline.lualine_x
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline.lualine_y
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.tabline.lualine_z
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.theme
The theme to use for lualine-nvim.
default: auto
Type: null or string or (attribute set)
Default: null
Declared by:
plugins.lualine.winbar
Winbar configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.lualine.winbar.lualine_a
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.winbar.lualine_b
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.winbar.lualine_c
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.winbar.lualine_x
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.winbar.lualine_y
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.lualine.winbar.lualine_z
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.luasnip.enable
Whether to enable Enable luasnip.
Type: boolean
Default: false
Example: true
Declared by:
plugins.luasnip.package
Plugin to use for luasnip
Type: package
Default: <derivation vimplugin-luasnip-2023-07-05>
Declared by:
plugins.luasnip.fromVscode
This option has no description.
Type: list of (submodule)
Default: [ ]
Example:
''
[
{}
{
paths = ./path/to/snippets;
}
]
# generates:
#
# require("luasnip.loaders.from_vscode").lazy_load({})
# require("luasnip.loaders.from_vscode").lazy_load({['paths'] = {'/nix/store/.../path/to/snippets'}})
#
''
Declared by:
plugins.luasnip.fromVscode.*.exclude
List of languages to exclude, by default is empty.
Type: null or (list of string)
Default: null
Declared by:
plugins.luasnip.fromVscode.*.include
List of languages to include, by default is not set.
Type: null or (list of string)
Default: null
Declared by:
plugins.luasnip.fromVscode.*.lazyLoad
Whether or not to lazy load the snippets
Type: boolean
Default: true
Declared by:
plugins.luasnip.fromVscode.*.paths
This option has no description.
Type: null or string or path or (submodule) or list of (string or path or (submodule))
Default: null
Declared by:
plugins.magma-nvim.enable
Whether to enable magma-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.magma-nvim.package
Plugin to use for magma-nvim
Type: package
Default: <derivation vimplugin-magma-nvim-goose-2023-03-13>
Declared by:
plugins.magma-nvim.automaticallyOpenOutput
If this is true, then whenever you have an active cell its output window will be automatically shown.
If this is false, then the output window will only be automatically shown when you’ve just evaluated the code. So, if you take your cursor out of the cell, and then come back, the output window won’t be opened (but the cell will be highlighted). This means that there will be nothing covering your code. You can then open the output window at will using :MagmaShowOutput.
Default: true
Type: null or boolean
Default: null
Example: false
Declared by:
plugins.magma-nvim.cellHighlightGroup
The highlight group to be used for highlighting cells.
Default: “CursorLine”
Type: null or string
Default: null
Example: null
Declared by:
plugins.magma-nvim.imageProvider
This configures how to display images. The following options are available:
-
“none” – don’t show images.
-
“ueberzug” – use Ueberzug to display images.
-
“kitty” – use the Kitty protocol to display images.
Default: “none”
Type: null or one of “none”, “uberzug”, “kitty”
Default: null
Example: null
Declared by:
plugins.magma-nvim.outputWindowBorders
If this is true, then the output window will have rounded borders. If it is false, it will have no borders.
Default: true
Type: null or boolean
Default: null
Example: false
Declared by:
plugins.magma-nvim.savePath
Where to save/load with :MagmaSave and :MagmaLoad (with no parameters). The generated file is placed in this directory, with the filename itself being the buffer’s name, with % replaced by %% and / replaced by %, and postfixed with the extension .json.
Type: null or string
Default: null
Example: null
Declared by:
plugins.magma-nvim.showMimetypeDebug
If this is true, then before any non-iostream output chunk, Magma shows the mimetypes it received for it. This is meant for debugging and adding new mimetypes.
Default: false
Type: null or boolean
Default: null
Example: true
Declared by:
plugins.magma-nvim.wrapOutput
If this is true, then text output in the output window will be wrapped (akin to set wrap).
Default: true
Type: null or boolean
Default: null
Example: false
Declared by:
plugins.mark-radar.enable
Whether to enable mark-radar.
Type: boolean
Default: false
Example: true
Declared by:
plugins.mark-radar.package
Plugin to use for mark-radar
Type: package
Default: <derivation vimplugin-mark-radar.nvim-2021-06-22>
Declared by:
plugins.mark-radar.backgroundHighlight
Whether to highlight the background.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.mark-radar.backgroundHighlightGroup
The name of the highlight group to use for the background.
default: RadarBackground
Type: null or string
Default: null
Declared by:
plugins.mark-radar.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.mark-radar.highlightGroup
The name of the highlight group to use.
default: RadarMark
Type: null or string
Default: null
Declared by:
plugins.mark-radar.setDefaultMappings
Whether to set default mappings.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.enable
Whether to enable markdown-preview.
Type: boolean
Default: false
Example: true
Declared by:
plugins.markdown-preview.package
Plugin to use for markdown-preview
Type: package
Default: <derivation vimplugin-markdown-preview.nvim-2022-05-13>
Declared by:
plugins.markdown-preview.autoClose
Auto close current preview window when change from markdown buffer to another buffer
default: true
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.autoStart
Open the preview window after entering the markdown buffer
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.browser
The browser to open the preview page
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.browserFunc
A custom vim function name to open preview page. This function will receive url as param.
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.commandForGlobal
Enable markdown preview for all files (by default, the plugin is only enabled for markdown files)
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.echoPreviewUrl
Echo preview page url in command line when opening the preview page
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.fileTypes
Recognized filetypes. These filetypes will have MarkdownPreview… commands.
default: ['markdown']
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.highlightCss
Custom highlight style. Must be an absolute path like ‘/Users/username/highlight.css’ or expand(‘~/highlight.css’).
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.markdownCss
Custom markdown style. Must be an absolute path like ‘/Users/username/markdown.css’ or expand(‘~/markdown.css’).
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.openIp
Custom IP used to open the preview page. This can be useful when you work in remote vim and preview on local browser. For more detail see: https://github.com/iamcco/markdown-preview.nvim/pull/9;.
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.openToTheWorld
Make the preview server available to others in your network. By default, the server listens on localhost (127.0.0.1).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.pageTitle
preview page title. $${name} will be replaced with the file name.
default: 「${name}」
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.port
Custom port to start server or empty for random
default: ``
Type: null or string
Default: null
Declared by:
plugins.markdown-preview.previewOptions
Options for markdown render
Type: null or (submodule)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.content_editable
Content editable from the preview page
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.previewOptions.disable_filename
Disable filename header for the preview page
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.previewOptions.disable_sync_scroll
Disable sync scroll
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.previewOptions.flowchart_diagrams
flowcharts diagrams options
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.hide_yaml_meta
Hide yaml metadata.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.previewOptions.katex
katex options for math
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.maid
mermaid options
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.mkit
markdown-it options for render
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.sequence_diagrams
js-sequence-diagrams options
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.sync_scroll_type
Scroll type:
-
“middle”: The cursor position is always shown at the middle of the preview page.
-
“top”: The vim top viewport is always shown at the top of the preview page.
-
“relative”: The cursor position is always shown at the relative positon of the preview page.
default: middle
Type: null or one of “middle”, “top”, “relative”
Default: null
Declared by:
plugins.markdown-preview.previewOptions.toc
Toc options
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.previewOptions.uml
markdown-it-plantuml options
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.markdown-preview.refreshSlow
Refresh markdown when save the buffer or leave from insert mode, default false is auto refresh markdown as you edit or move the cursor
default: false
Type: null or boolean
Default: null
Declared by:
plugins.markdown-preview.theme
Default theme (dark or light). By default the theme is define according to the preferences of the system.
default: dark
Type: null or one of “dark”, “light”
Default: null
Declared by:
plugins.mini.enable
Whether to enable mini.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.mini.package
Plugin to use for mini.nvim
Type: package
Default: <derivation vimplugin-mini.nvim-2023-07-09>
Declared by:
plugins.mini.modules
Enable and configure the mini modules. The keys are the names of the modules (without the mini. prefix). The value is an attrs of configuration options for the module. Leave the attrs empty to use the module’s default configuration.
Type: attribute set of (attribute set)
Default: { }
Example:
{
ai = {
n_lines = 50;
search_method = "cover_or_next";
};
surrounds = { };
}
Declared by:
plugins.neo-tree.enable
Whether to enable neo-tree.
Type: boolean
Default: false
Example: true
Declared by:
plugins.neo-tree.enableDiagnostics
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.enableGitStatus
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.enableModifiedMarkers
Show markers for files with unsaved changes.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.enableRefreshOnWrite
Refresh the tree when a file is written. Only used if use_libuv_file_watcher is false.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.package
Plugin to use for neo-tree
Type: package
Default: <derivation vimplugin-neo-tree.nvim-2023-07-03>
Declared by:
plugins.neo-tree.addBlankLineAtTop
Add a blank line at the top of the tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.autoCleanAfterSessionRestore
Automatically clean up broken neo-tree buffers saved in sessions
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.buffers
Buffers options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.buffers.bindToCwd
Bind to current working directory.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.buffers.followCurrentFile
This will find and focus the file in the active buffer every time the current file is changed while the tree is open.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.buffers.groupEmptyDirs
When true, empty directories will be grouped together.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.buffers.window
Window options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.buffers.window.mappings
Mapping options
default: { "<bs>" = "navigate_up"; "." = "set_root"; bd = "buffer_delete"; }
Type: null or (attribute set of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.closeFloatsOnEscapeKey
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.closeIfLastWindow
Close Neo-tree if it is the last window left in the tab
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs
Configuration for default components.
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.container
Container options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.container.enableCharacterFade
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.container.rightPadding
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.container.width
default: 100%
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics
diagnostics
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights
highlights
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.error
default: DiagnosticSignError
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.hint
default: DiagnosticSignHint
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.info
default: DiagnosticSignInfo
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.highlights.warn
default: DiagnosticSignWarn
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols
symbols
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.error
default: X
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.hint
default: H
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.info
default: I
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.diagnostics.symbols.warn
default: !
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus
git status
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.align
icon alignment
default: right
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols
Symbol characters for git status. Set to empty string to not show them.
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.added
added
default: ✚
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.conflict
conflict
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.deleted
deleted
default: ✖
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.ignored
ignored
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.modified
modified
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.renamed
renamed
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.staged
staged
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.unstaged
unstaged
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.gitStatus.symbols.untracked
untracked
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.default
Only a fallback, if you use nvim-web-devicons and configure default icons there then this will never be used.
default: *
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.folderClosed
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.folderEmpty
default: ﰊ
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.folderEmptyOpen
default: ﰊ
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.folderOpen
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.icon.highlight
Only a fallback, if you use nvim-web-devicons and configure default icons there then this will never be used.
default: NeoTreeFileIcon
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent
indent
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.expanderCollapsed
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.expanderExpanded
default:
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.expanderHighlight
default: NeoTreeExpander
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.highlight
default: NeoTreeIndentMarker
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.indentMarker
default: │
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.indentSize
default: 2
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.lastIndentMarker
default: └
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.padding
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.withExpanders
If null and file nesting is enabled, will enable expanders.
default: null
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.indent.withMarkers
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.modified
modified
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.modified.highlight
default: NeoTreeModified
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.modified.symbol
default: [+]
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.name
name
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.name.highlight
default: NeoTreeFileName
Type: null or string
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.name.trailingSlash
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultComponentConfigs.name.useGitStatusColors
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.defaultSource
default: filesystem
Type: null or string
Default: null
Declared by:
plugins.neo-tree.documentSymbols.customKinds
A table mapping the LSP kind id (an integer) to the LSP kind name that is used for kinds.
For the list of kinds (id and name), please refer to https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentSymbol
Type: attribute set of string
Default: { }
Example:
{
"252" = "TypeAlias";
}
Declared by:
plugins.neo-tree.documentSymbols.followCursor
If set to true, will automatically focus on the symbol under the cursor.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.documentSymbols.kinds
An attrs specifying how LSP kinds should be rendered. Each entry should map the LSP kind name to an icon and a highlight group, for example Class = { icon = ""; hl = "Include"; }
Type: null or (attribute set of (submodule))
Default: null
Declared by:
plugins.neo-tree.documentSymbols.kinds.<name>.hl
Highlight group for this LSP kind.
Type: string
Example: "Include"
Declared by:
plugins.neo-tree.documentSymbols.kinds.<name>.icon
Icon for this LSP kind.
Type: string
Example: ""
Declared by:
plugins.neo-tree.eventHandlers
Configuration of event handlers. Attrs:
-
keys are the events (e.g.
before_render,file_opened) -
values are lua code defining the callback function.
Example:
{
before_render = \'\'
function (state)
-- add something to the state that can be used by custom components
end
\'\';
file_opened = \'\'
function(file_path)
--auto close
require("neo-tree").close_all()
end
\'\';
}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.neo-tree.example
example options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.example.renderers
renderers
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.example.renderers.custom
custom renderers
default: [ "indent" { name = "icon"; default = "C"; } "custom" "name" ]
Type: null or (list of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.example.window
Window options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.example.window.mappings
Mapping options
default: { "<cr>" = "toggle_node"; "<C-e>" = "example_command"; d = "show_debug_info"; }
Type: null or (attribute set of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.neo-tree.extraSources
Extra sources to be added to the sources. This is an internal nixvim option.
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem
Filesystem options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.filesystem.asyncDirectoryScan
-
“auto” means refreshes are async, but it’s synchronous when called from the Neotree commands.
-
“always” means directory scans are always async.
-
“never” means directory scans are never async.
default: "auto"
Type: null or one of “auto”, “always”, “never”
Default: null
Declared by:
plugins.neo-tree.filesystem.bindToCwd
true creates a 2-way binding between vim’s cwd and neo-tree’s root.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.cwdTarget
cwd target
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.filesystem.cwdTarget.current
current is when position = current
default: window
Type: null or string
Default: null
Declared by:
plugins.neo-tree.filesystem.cwdTarget.sidebar
sidebar is when position = left or right
default: tab
Type: null or string
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems
filtered items
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.alwaysShow
Files/folders to always show.
Example: [".gitignore"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.forceVisibleInEmptyFolder
when true, hidden files will be shown if the root folder is otherwise empty
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.hideByName
hide by name
default: [".DS_Store" "thumbs.db"]
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.hideByPattern
Hide by pattern.
Example:
[
"*.meta"
"*/src/*/tsconfig.json"
]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.hideDotfiles
hide dotfiles
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.hideGitignored
hide gitignored files
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.hideHidden
only works on Windows for hidden files/directories
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.neverShow
Files/folders to never show.
Example: [".DS_Store" "thumbs.db"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.neverShowByPattern
Files/folders to never show (by pattern).
Example: [".null-ls_*"]
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.showHiddenCount
when true, the number of hidden items in each folder will be shown as the last entry
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.filteredItems.visible
when true, they will just be displayed differently than normal items
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.findArgs
Find arguments
Either use a list of strings:
findArgs = {
fd = [
"--exclude"
".git"
"--exclude"
"node_modules"
];
};
Or use a function instead of list of strings
findArgs = \'\'
find_args = function(cmd, path, search_term, args)
if cmd ~= "fd" then
return args
end
--maybe you want to force the filter to always include hidden files:
table.insert(args, "--hidden")
-- but no one ever wants to see .git files
table.insert(args, "--exclude")
table.insert(args, ".git")
-- or node_modules
table.insert(args, "--exclude")
table.insert(args, "node_modules")
--here is where it pays to use the function, you can exclude more for
--short search terms, or vary based on the directory
if string.len(search_term) < 4 and path == "/home/cseickel" then
table.insert(args, "--exclude")
table.insert(args, "Library")
end
return args
end
\'\';
Type: null or string or (submodule)
Default: null
Declared by:
plugins.neo-tree.filesystem.findByFullPathWords
false means it only searches the tail of a path. true will change the filter into a full path
search with space as an implicit “.*”, so fi init will match: `./sources/filesystem/init.lua
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.findCommand
This is determined automatically, you probably don’t need to set it
default: fd
Type: null or string
Default: null
Declared by:
plugins.neo-tree.filesystem.followCurrentFile
This will find and focus the file in the active buffer every time the current file is changed while the tree is open.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.groupEmptyDirs
when true, empty folders will be grouped together
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.hijackNetrwBehavior
-
“open_default”: netrw disabled, opening a directory opens neo-tree in whatever position is specified in window.position
-
“open_current”: netrw disabled, opening a directory opens within the window like netrw would, regardless of window.position
-
“disabled”: netrw left alone, neo-tree does not handle opening dirs
default: "open_default"
Type: null or one of “open_default”, “open_current”, “disabled”
Default: null
Declared by:
plugins.neo-tree.filesystem.scanMode
-
“shallow”: Don’t scan into directories to detect possible empty directory a priori.
-
“deep”: Scan into directories to detect empty or grouped empty directories a priori.
default: "shallow"
Type: null or one of “shallow”, “deep”
Default: null
Declared by:
plugins.neo-tree.filesystem.searchLimit
max number of search results when using filters
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.filesystem.useLibuvFileWatcher
This will use the OS level file watchers to detect changes instead of relying on nvim autocmd events.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.filesystem.window
Window options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.filesystem.window.mappings
Mapping options
default: ```` { H = “toggle_hidden”; “/” = “fuzzy_finder”; D = “fuzzy_finder_directory”; # “/” = “filter_as_you_type”; # this was the default until v1.28 “#” = “fuzzy_sorter”; # fuzzy sorting using the fzy algorithm # D = “fuzzy_sorter_directory”; f = “filter_on_submit”; “<C-x>” = “clear_filter”; “<bs>” = “navigate_up”; “.” = “set_root”; “[g” = “prev_git_modified”; “]g” = “next_git_modified”; }
`
Type: null or (attribute set of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.gitStatus
git status options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.gitStatus.window
Window options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.gitStatus.window.mappings
Mapping options
default: { A = "git_add_all"; gu = "git_unstage_file"; ga = "git_add_file"; gr = "git_revert_file"; gc = "git_commit"; gp = "git_push"; gg = "git_commit_and_push"; }
Type: null or (attribute set of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.gitStatusAsync
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.gitStatusAsyncOptions
These options are for people with VERY large git repos
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.gitStatusAsyncOptions.batchDelay
delay in ms between batches. Spreads out the workload to let other processes run.
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.gitStatusAsyncOptions.batchSize
How many lines of git status results to process at a time
default: 1000
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.gitStatusAsyncOptions.maxLines
How many lines of git status results to process. Anything after this will be dropped. Anything before this will be used. The last items to be processed are the untracked files.
default: 10000
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.hideRootNode
Hide the root node.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.logLevel
default: "info"
Type: null or one of “trace”, “debug”, “info”, “warn”, “error”, “fatal”
Default: null
Declared by:
plugins.neo-tree.logToFile
use :NeoTreeLogs to show the file
default: false
Type: null or boolean or string
Default: null
Declared by:
plugins.neo-tree.nestingRules
nesting rules
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.neo-tree.openFilesInLastWindow
If false, open files in top left window
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.popupBorderStyle
default: "NC"
Type: null or one of “NC”, “double”, “none”, “rounded”, “shadow”, “single”, “solid”
Default: null
Declared by:
plugins.neo-tree.renderers
Renderers configuration
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.renderers.directory
directory renderers
default: [ "indent" "icon" "current_filter" { name = "container"; content = [ { name = "name"; zindex = 10; } { name = "clipboard"; zindex = 10; } { name = "diagnostics"; errors_only = true; zindex = 20; align = "right"; hide_when_expanded = true; } { name = "git_status"; zindex = 20; align = "right"; hide_when_expanded = true; } ]; } ]
Type: null or (list of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.renderers.file
file renderers
default: [ "indent" "icon" { name = "container"; content = [ { name = "name"; zindex = 10; } { name = "clipboard"; zindex = 10; } { name = "bufnr"; zindex = 10; } { name = "modified"; zindex = 20; align = "right"; } { name = "diagnostics"; zindex = 20; align = "right"; } { name = "git_status"; zindex = 20; align = "right"; } ]; } ]
Type: null or (list of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.renderers.message
message renderers
default: [ { name = "indent"; with_markers = false; } { name = "name"; highlight = "NeoTreeMessage"; } ]
Type: null or (list of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.renderers.terminal
message renderers
default: [ "indent" "icon" "name" "bufnr" ]
Type: null or (list of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.resizeTimerInterval
In ms, needed for containers to redraw right aligned and faded content. Set to -1 to disable the resize timer entirely.
|
Note
|
this will speed up to 50 ms for 1 second following a resize |
default: 500
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.retainHiddenRootIndent
If the root node is hidden, keep the indentation anyhow. This is needed if you use expanders because they render in the indent.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sortCaseInsensitive
Used when sorting files and directories in the tree
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sortFunction
Uses a custom function for sorting files and directories in the tree
default: nil
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.contentLayout
Defines how the labels are placed inside a tab. This only takes effect when the tab width is greater than the length of label i.e. tabsLayout = "equal", "focus" or when tabsMinWidth is large enough.
Following options are available. “start” : left aligned / 裡 bufname /… “end” : right aligned / 裡 bufname /… “center” : centered with equal padding / 裡 bufname /…
default: "start"
Type: null or one of “start”, “end”, “focus”
Default: null
Declared by:
plugins.neo-tree.sourceSelector.highlightBackground
default: NeoTreeTabInactive
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.highlightSeparator
default: NeoTreeTabSeparatorInactive
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.highlightSeparatorActive
default: NeoTreeTabSeparatorActive
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.highlightTab
default: NeoTreeTabInactive
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.highlightTabActive
default: NeoTreeTabActive
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.padding
Defines the global padding of the source selector. It can be an integer or an attrs with keys left and right. Setting padding = 2 is exactly the same as { left = 2; right = 2; }.
Example: { left = 2; right = 0; }
default: 0
Type: null or signed integer or attribute set of signed integer
Default: null
Declared by:
plugins.neo-tree.sourceSelector.separator
{ left = “▏”; right= “▕”; }
default: Can be a string or a table
Type: null or string or (submodule)
Default: null
Declared by:
plugins.neo-tree.sourceSelector.separatorActive
null
default: Set separators around the active tab. null falls back to sourceSelector.separator.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.neo-tree.sourceSelector.showScrolledOffParentNode
If true, tabs are replaced with the parent path of the top visible node when scrolled down.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sourceSelector.showSeparatorOnEdge
Takes a boolean value where false (default) hides the separators on the far left / right. Especially useful when left and right separator are the same.
'true' : ┃/ ~ \/ ~ \/ ~ \┃ 'false' : ┃ ~ \/ ~ \/ ~ ┃
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sourceSelector.sources
Configure the characters shown on each tab.
Type: null or (list of (submodule))
Default: null
Declared by:
plugins.neo-tree.sourceSelector.sources.*.displayName
How that source to appear in the bar.
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.sources.*.source
Name of the source to add to the bar.
Type: string
Declared by:
plugins.neo-tree.sourceSelector.statusline
toggle to show selector on statusline
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sourceSelector.tabsLayout
Defines how the tabs are aligned inside the window when there is more than enough space. The following options are available. active will expand the focused tab as much as possible. Bars denote the edge of window.
"start" : left aligned ┃/ ~ \/ ~ \/ ~ \ ┃ "end" : right aligned ┃ / ~ \/ ~ \/ ~ \┃ "center" : centered with equal padding ┃ / ~ \/ ~ \/ ~ \ ┃ "equal" : expand all tabs equally to fit the window width ┃/ ~ \/ ~ \/ ~ \┃ "active" : expand the focused tab to fit the window width ┃/ focused tab \/ ~ \/ ~ \┃
default: "equal"
Type: null or one of “start”, “end”, “center”, “equal”, “focus”
Default: null
Declared by:
plugins.neo-tree.sourceSelector.tabsMaxWidth
This will truncate text even if textTruncToFit = false
default: null
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.sourceSelector.tabsMinWidth
If int padding is added based on contentLayout
default: null
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.sourceSelector.truncationCharacter
Character to use when truncating the tab label
default: …
Type: null or string
Default: null
Declared by:
plugins.neo-tree.sourceSelector.winbar
toggle to show selector on winbar
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.sources
If a user has a sources list it will replace this one. Only sources listed here will be loaded. You can also add an external source by adding it’s name to this list. The name used here must be the same name you would use in a require() call.
default: ["filesystem" "buffers" "git_status"]
Type: null or (list of string)
Default: null
Declared by:
plugins.neo-tree.useDefaultMappings
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.usePopupsForInput
If false, inputs will use vim.ui.input() instead of custom floats.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.window
Window options. See https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/popup for possible options. These can also be functions that return these options.
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.window.autoExpandWidth
Expand the window when file exceeds the window width. does not work with position = “float”
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.window.height
Applies to top and bottom positions
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.neo-tree.window.insertAs
Affects how nodes get inserted into the tree during creation/pasting/moving of files if the node under the cursor is a directory:
-
“child”: Insert nodes as children of the directory under cursor.
-
“sibling”: Insert nodes as siblings of the directory under cursor.
default: "child"
Type: null or one of “child”, “sibling”
Default: null
Declared by:
plugins.neo-tree.window.mappingOptions
Mapping options
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.window.mappingOptions.noremap
noremap
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.window.mappingOptions.nowait
nowait
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.window.mappings
Mapping options
default: ```` { “<space>” = { command = “toggle_node”; # disable nowait if you have existing combos starting with this char that you want to use nowait = false; }; “<2-LeftMouse>” = “open”; “<cr>” = “open”; “<esc>” = “revert_preview”; P = { command = “toggle_preview”; config = { use_float = true; }; }; l = “focus_preview”; S = “open_split”; # S = “split_with_window_picker”; s = “open_vsplit”; # s = “vsplit_with_window_picker”; t = “open_tabnew”; # “<cr>” = “open_drop”; # t = “open_tab_drop”; w = “open_with_window_picker”; C = “close_node”; z = “close_all_nodes”; # Z = “expand_all_nodes”; R = “refresh”; a = { command = “add”; # some commands may take optional config options, see :h neo-tree-mappings for details config = { show_path = “none”; # “none”, “relative”, “absolute” }; }; A = “add_directory”; # also accepts the config.show_path and config.insert_as options. d = “delete”; r = “rename”; y = “copy_to_clipboard”; x = “cut_to_clipboard”; p = “paste_from_clipboard”; c = “copy”; # takes text input for destination, also accepts the config.show_path and config.insert_as options m = “move”; # takes text input for destination, also accepts the config.show_path and config.insert_as options e = “toggle_auto_expand_width”; q = “close_window”; “?” = “show_help”; “<” = “prev_source”; “>” = “next_source”; }
`
Type: null or (attribute set of (string or (attribute set)))
Default: null
Declared by:
plugins.neo-tree.window.popup
Settings that apply to float position only
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.window.popup.position
50% means center it. You can also specify border here, if you want a different setting from the global popupBorderStyle.
default: 80%
Type: null or string
Default: null
Declared by:
plugins.neo-tree.window.popup.size
size
Type: null or (submodule)
Default: null
Declared by:
plugins.neo-tree.window.popup.size.height
height
default: 80%
Type: null or string
Default: null
Declared by:
plugins.neo-tree.window.popup.size.width
height
default: 50%
Type: null or string
Default: null
Declared by:
plugins.neo-tree.window.position
position
default: "left"
Type: null or one of “left”, “right”, “top”, “bottom”, “float”, “current”
Default: null
Declared by:
plugins.neo-tree.window.sameLevel
Create and paste/move files/directories on the same level as the directory under cursor (as opposed to within the directory under cursor).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neo-tree.window.width
Applies to left and right positions
default: 40
Type: null or signed integer
Default: null
Declared by:
plugins.neogen.enable
Whether to enable neogen.
Type: boolean
Default: false
Example: true
Declared by:
plugins.neogen.enablePlaceholders
If true, enables placeholders when inserting annotation
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neogen.package
Plugin to use for neogen
Type: package
Default: <derivation vimplugin-neogen-2023-06-09>
Declared by:
plugins.neogen.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.neogen.inputAfterComment
If true, go to annotation after insertion, and change to insert mode
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neogen.keymaps.generate
The only function required to use Neogen.
It’ll try to find the first parent that matches a certain type. For example, if you are inside a function, and called generate({ type = "func" }), Neogen will go until the start of the function and start annotating for you.
Type: null or string
Default: null
Declared by:
plugins.neogen.keymaps.generateClass
Generates annotation for class.
Type: null or string
Default: null
Declared by:
plugins.neogen.keymaps.generateFile
Generates annotation for file.
Type: null or string
Default: null
Declared by:
plugins.neogen.keymaps.generateFunction
Generates annotation for function.
Type: null or string
Default: null
Declared by:
plugins.neogen.keymaps.generateType
Generates annotation for type.
Type: null or string
Default: null
Declared by:
plugins.neogen.keymapsSilent
Whether Neogen keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.neogen.languages
Configuration for languages.
template.annotation_convention (default: check the language default configurations): Change the annotation convention to use with the language.
template.use_default_comment (default: true): Prepend any template line with the default comment for the filetype
template.position (fun(node: userdata, type: string):(number,number)?): Provide an absolute position for the annotation. If return values are nil, use default position
template.append: If you want to customize the position of the annotation.
template.append.child_name: What child node to use for appending the annotation.
template.append.position (before/after): Relative positioning with child_name.
template.<convention_name> (replace <convention_name> with an annotation convention): Template for an annotation convention. To know more about how to create your own template, go here: https://github.com/danymat/neogen/blob/main/docs/adding-languages.md#default-generator
Example:
{
csharp = {
template = {
annotation_convention = "...";
};
};
}
default: see upstream documentation
Type: null or (attribute set)
Default: null
Declared by:
plugins.neogen.placeholderHighligt
Placeholders highlights to use. If you don’t want custom highlight, pass “None”
default: DiagnosticHint
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.args
Placholder for args.
default: [TODO:args]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.attribute
Placholder for attribute.
default: [TODO:attribute]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.class
Placholder for class.
default: [TODO:class]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.description
Placholder for description.
default: [TODO:description]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.kwargs
Placholder for kwargs.
default: [TODO:kwargs]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.parameter
Placholder for parameter.
default: [TODO:parameter]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.return
Placholder for return.
default: [TODO:return]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.throw
Placholder for throw.
default: [TODO:throw]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.tparam
Placholder for tparam.
default: [TODO:tparam]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.type
Placholder for type.
default: [TODO:type]
Type: null or string
Default: null
Declared by:
plugins.neogen.placeholdersText.varargs
Placholder for varargs.
default: [TODO:varargs]
Type: null or string
Default: null
Declared by:
plugins.neogen.snippetEngine
Use a snippet engine to generate annotations. Some snippet engines come out of the box bundled with neogen:
-
"luasnip"(https://github.com/L3MON4D3/LuaSnip) -
"snippy"(https://github.com/dcampos/nvim-snippy) -
"vsnip"(https://github.com/hrsh7th/vim-vsnip)
Type: null or string
Default: null
Declared by:
plugins.neogit.enable
Whether to enable neogit.
Type: boolean
Default: false
Example: true
Declared by:
plugins.neogit.package
Plugin to use for neogit
Type: package
Default: <derivation vimplugin-neogit-2023-07-07>
Declared by:
plugins.neogit.autoRefresh
Enable Auto Refresh
Type: null or boolean
Default: null
Declared by:
plugins.neogit.commitPopup
Commit popup configuration
Type: submodule
Default: { }
Declared by:
plugins.neogit.commitPopup.kind
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.neogit.disableBuiltinNotifications
Disable builtin notifications
Type: null or boolean
Default: null
Declared by:
plugins.neogit.disableCommitConfirmation
Disable the commit confirmation prompt
Type: null or boolean
Default: null
Declared by:
plugins.neogit.disableContextHighlighting
Disable the context highlighting
Type: null or boolean
Default: null
Declared by:
plugins.neogit.disableHint
Disable hint
Type: null or boolean
Default: null
Declared by:
plugins.neogit.disableSigns
Disable signs
Type: null or boolean
Default: null
Declared by:
plugins.neogit.integrations
Tools integration
Type: submodule
Default: { }
Declared by:
plugins.neogit.integrations.diffview
Enable diff popup
Type: boolean
Default: false
Declared by:
plugins.neogit.kind
The way of opening neogit
Type: null or string
Default: null
Declared by:
plugins.neogit.mappings
Custom mappings
Type: submodule
Default: { }
Declared by:
plugins.neogit.mappings.status
This option has no description.
Type: null or (attribute set of (one of “Close”, “Depth1”, “Depth2”, “Depth3”, “Depth4”, “Toggle”, “Discard”, “Stage”, “StageUnstaged”, “StageAll”, “GoToFile”, “Unstaged”, “UnstagedStage”, “CommandHistory”, “RefreshBuffer”, “HelpPopup”, “PullPopup”, “PushPopup”, “CommitPopup”, “LogPopup”, “StashPopup”, “BranchPopup”))
Default: null
Declared by:
plugins.neogit.sections
Section configuration
Type: submodule
Default: { }
Declared by:
plugins.neogit.sections.recent
Options for recent commits section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.recent.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.staged
Options for staged section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.staged.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.stashes
Options for stashes section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.stashes.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.unmerged
Options for unmerged section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.unmerged.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.unpulled
Options for unpulled section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.unpulled.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.unstaged
Options for unstaged section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.unstaged.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.sections.untracked
Options for untracked section
Type: null or (submodule)
Default: null
Declared by:
plugins.neogit.sections.untracked.folded
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.neogit.signs
Customize displayed signs
Type: submodule
Default: { }
Declared by:
plugins.neogit.signs.hunk
Cosed and opened signs for hunks
Type: null or (list of string)
Default: null
Declared by:
plugins.neogit.signs.item
Cosed and opened signs for items
Type: null or (list of string)
Default: null
Declared by:
plugins.neogit.signs.section
Cosed and opened signs for sections
Type: null or (list of string)
Default: null
Declared by:
plugins.neogit.useMagitKeybindings
Enable Magit keybindings
Type: null or boolean
Default: null
Declared by:
plugins.neorg.enable
Whether to enable neorg.
Type: boolean
Default: false
Example: true
Declared by:
plugins.neorg.package
Plugin to use for neorg
Type: package
Default: <derivation vimplugin-neorg-2023-07-09>
Declared by:
plugins.neorg.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.neorg.lazyLoading
default: false
Type: null or boolean
Default: null
Declared by:
plugins.neorg.logger.floatPrecision
Can limit the number of decimals displayed for floats
default: 0.01
Type: null or floating point number
Default: null
Declared by:
plugins.neorg.logger.highlights
Should highlighting be used in console (using echohl)
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neorg.logger.level
Any messages above this level will be logged
default: "warn"
Type: null or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: null
Declared by:
plugins.neorg.logger.modes.debug.hl
Highlight for mode debug
default: Comment
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.debug.level
Level for mode debug
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: "debug"
Declared by:
plugins.neorg.logger.modes.error.hl
Highlight for mode error
default: ErrorMsg
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.error.level
Level for mode error
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: "error"
Declared by:
plugins.neorg.logger.modes.fatal.hl
Highlight for mode fatal
default: ErrorMsg
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.fatal.level
Level for mode fatal
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: 5
Declared by:
plugins.neorg.logger.modes.info.hl
Highlight for mode info
default: None
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.info.level
Level for mode info
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: "info"
Declared by:
plugins.neorg.logger.modes.trace.hl
Highlight for mode trace
default: Comment
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.trace.level
Level for mode trace
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: "trace"
Declared by:
plugins.neorg.logger.modes.warn.hl
Highlight for mode warn
default: WarningMsg
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.modes.warn.level
Level for mode warn
Type: signed integer or one of “debug”, “error”, “fatal”, “info”, “trace”, “warn”
Default: "warn"
Declared by:
plugins.neorg.logger.plugin
Name of the plugin. Prepended to log messages
default: neorg
Type: null or string
Default: null
Declared by:
plugins.neorg.logger.useConsole
Should print the output to neovim while running
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neorg.logger.useFile
Should write to a file
default: true
Type: null or boolean
Default: null
Declared by:
plugins.neorg.modules
Modules configuration.
Type: attribute set of (attribute set)
Default: { }
Example:
{
"core.defaults" = {
__empty = null;
};
"core.dirman" = {
config = {
workspaces = {
home = "~/notes/home";
work = "~/notes/work";
};
};
};
}
Declared by:
plugins.netman.enable
Whether to enable netman.nvim, a framework to access remote resources.
Type: boolean
Default: false
Example: true
Declared by:
plugins.netman.package
Plugin to use for netman.nvim
Type: package
Default: <derivation vimplugin-netman.nvim-2023-04-19>
Declared by:
plugins.netman.neoTreeIntegration
Whether to enable support for netman as a neo-tree source.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nix.enable
Whether to enable Enable nix.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nix.package
Plugin to use for nix
Type: package
Default: <derivation vimplugin-vim-nix-2022-04-25>
Declared by:
plugins.noice.enable
Whether to enable noice.nvim, an experimental nvim UI. Note that if treesitter is enabled you need the following parsers: vim, regex, lua, bash, markdown, markdown_inline .
Type: boolean
Default: false
Example: true
Declared by:
plugins.noice.package
Plugin to use for noice
Type: package
Default: <derivation vimplugin-noice.nvim-2023-07-01>
Declared by:
plugins.noice.cmdline
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.cmdline.enabled
enables Noice cmdline UI
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.cmdline.format
conceal: (default=true) This will hide the text in the cmdline that matches the pattern. view: (default is cmdline view) opts: any options passed to the view icon_hl_group: optional hl_group for the icon title: set to anything or empty string to hide lua = false, to disable a format, set to false
default: { cmdline = {pattern = "^:"; icon = ""; lang = "vim";}; search_down = {kind = "search"; pattern = "^/"; icon = " "; lang = "regex";}; search_up = {kind = "search"; pattern = "?%?"; icon = " "; lang = "regex";}; filter = {pattern = "^:%s*!"; icon = "$"; lang = "bash";}; lua = {pattern = "^:%s*lua%s+"; icon = ""; lang = "lua";}; help = {pattern = "^:%s*he?l?p?%s+"; icon = "";}; input = {}; }
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.noice.cmdline.opts
default: {}
Type: null or anything
Default: null
Declared by:
plugins.noice.cmdline.view
default: cmdline_popup
Type: null or string
Default: null
Declared by:
plugins.noice.commands
You can add any custom commands that will be available with :Noice command
default: { history = { view = "split"; opts = {enter = true; format = "details";}; filter = { any = [ {event = "notify";} {error = true;} {warning = true;} {event = "msg_show"; kind = [""];} {event = "lsp"; kind = "message";} ]; }; }; last = { view = "popup"; opts = {enter = true; format = "details";}; filter = { any = [ {event = "notify";} {error = true;} {warning = true;} {event = "msg_show"; kind = [""];} {event = "lsp"; kind = "message";} ]; }; filter_opts = {count = 1;}; }; errors = { view = "popup"; opts = {enter = true; format = "details";}; filter = {error = true;}; filter_opts = {reverse = true;}; }; }
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.noice.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.noice.format
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.noice.health
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.health.checker
Disable if you don’t want health checks to run
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.documentation
defaults for hover and signature help
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.documentation.opts
default: { lang = "markdown"; replace = true; render = "plain"; format = ["{message}"]; win_options = { concealcursor = "n"; conceallevel = 3; }; }
Type: null or anything
Default: null
Declared by:
plugins.noice.lsp.documentation.view
default: hover
Type: null or string
Default: null
Declared by:
plugins.noice.lsp.hover
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.hover.enabled
enable hover UI
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.hover.opts
merged with defaults from documentation
default: {}
Type: null or anything
Default: null
Declared by:
plugins.noice.lsp.hover.view
when null, use defaults from documentation
default: null
Type: null or string
Default: null
Declared by:
plugins.noice.lsp.message
Messages shown by lsp servers
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.message.enabled
enable display of messages
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.message.opts
default: {}
Type: null or anything
Default: null
Declared by:
plugins.noice.lsp.message.view
default: notify
Type: null or string
Default: null
Declared by:
plugins.noice.lsp.override
default: { "vim.lsp.util.convert_input_to_markdown_lines" = false; "vim.lsp.util.stylize_markdown" = false; "cmp.entry.get_documentation" = false; }
Type: null or (attribute set of boolean)
Default: null
Declared by:
plugins.noice.lsp.progress
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.progress.enabled
enable LSP progress
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.progress.format
Lsp Progress is formatted using the builtins for lsp_progress
default: "lsp_progress"
Type: null or string or anything
Default: null
Declared by:
plugins.noice.lsp.progress.formatDone
default: "lsp_progress"
Type: null or string or anything
Default: null
Declared by:
plugins.noice.lsp.progress.throttle
frequency to update lsp progress message
default: 1000 / 30
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.noice.lsp.progress.view
default: mini
Type: null or string
Default: null
Declared by:
plugins.noice.lsp.signature
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.signature.enabled
enable signature UI
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.signature.autoOpen
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.lsp.signature.autoOpen.enabled
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.signature.autoOpen.luasnip
Will open signature help when jumping to Luasnip insert nodes
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.signature.autoOpen.throttle
Debounce lsp signature help request by 50ms
default: 50
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.noice.lsp.signature.autoOpen.trigger
Automatically show signature help when typing a trigger character from the LSP
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.lsp.signature.opts
merged with defaults from documentation
default: {}
Type: null or anything
Default: null
Declared by:
plugins.noice.lsp.signature.view
when null, use defaults from documentation
default: null
Type: null or string
Default: null
Declared by:
plugins.noice.markdown
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.markdown.highlights
set highlight groups
default: { "|%S-|" = "@text.reference"; "@%S+" = "@parameter"; "^%s*(Parameters:)" = "@text.title"; "^%s*(Return:)" = "@text.title"; "^%s*(See also:)" = "@text.title"; "{%S-}" = "@parameter"; }
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.noice.markdown.hover
set handlers for hover (lua code)
default: { "|(%S-)|" = helpers.mkRaw "vim.cmd.help"; // vim help links "%[.-%]%((%S-)%)" = helpers.mkRaw "require("noice.util").open"; // markdown links }
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.noice.messages
|
Note
|
If you enable messages, then the cmdline is enabled automatically |
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.messages.enabled
enables the messages UI
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.messages.view
default view for messages
default: notify
Type: null or string
Default: null
Declared by:
plugins.noice.messages.viewError
default view for errors
default: notify
Type: null or string
Default: null
Declared by:
plugins.noice.messages.viewHistory
view for :messages
default: messages
Type: null or string
Default: null
Declared by:
plugins.noice.messages.viewSearch
view for search count messages
default: virtualtext
Type: null or string
Default: null
Declared by:
plugins.noice.messages.viewWarn
default view for warnings
default: notify
Type: null or string
Default: null
Declared by:
plugins.noice.notify
Noice can be used as vim.notify so you can route any notification like other messages Notification messages have their level and other properties set. event is always “notify” and kind can be any log level as a string The default routes will forward notifications to nvim-notify Benefit of using Noice for this is the routing and consistent history view
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.notify.enabled
enable notification handling
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.notify.view
default: notify
Type: null or string
Default: null
Declared by:
plugins.noice.popupmenu
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.popupmenu.enabled
enables the Noice popupmenu UI
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.popupmenu.backend
default: "nui"
Type: null or one of “nui”, “cmp”
Default: null
Declared by:
plugins.noice.popupmenu.kindIcons
Icons for completion item kinds. set to false to disable icons
default: {}
Type: null or boolean or attribute set of anything
Default: null
Declared by:
plugins.noice.presets
you can enable a preset by setting it to true, or a table that will override the preset
config. you can also add custom presets that you can enable/disable with enabled=true
default: { bottom_search = false; command_palette = false; long_message_to_split = false; inc_rename = false; lsp_doc_border = false; }
Type: null or boolean or anything
Default: null
Declared by:
plugins.noice.redirect
default options for require(‘noice’).redirect
default: { view = "popup"; filter = {event = "msg_show";}; }
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.noice.routes
default: []
Type: null or (list of attribute set of anything)
Default: null
Declared by:
plugins.noice.smartMove
noice tries to move out of the way of existing floating windows.
Type: null or (submodule)
Default: null
Declared by:
plugins.noice.smartMove.enabled
you can disable this behaviour here
default: true
Type: null or boolean
Default: null
Declared by:
plugins.noice.smartMove.excludedFiletypes
add any filetypes here, that shouldn’t trigger smart move
default: [ "cmp_menu" "cmp_docs" "notify"]
Type: null or (list of string)
Default: null
Declared by:
plugins.noice.status
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.noice.throttle
how frequently does Noice need to check for ui updates? This has no effect when in blocking mode
default: 1000 / 30
Type: null or signed integer or floating point number
Default: null
Declared by:
plugins.noice.views
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.notify.enable
Whether to enable notify.
Type: boolean
Default: false
Example: true
Declared by:
plugins.notify.package
Plugin to use for notify
Type: package
Default: <derivation vimplugin-nvim-notify-2023-06-05>
Declared by:
plugins.notify.backgroundColour
For stages that change opacity this is treated as the highlight between the window
Type: null or string
Default: null
Declared by:
plugins.notify.icons
Icons for the different levels
Type: null or (submodule)
Default: { }
Declared by:
plugins.notify.icons.debug
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.notify.icons.error
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.notify.icons.info
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.notify.icons.trace
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.notify.icons.warn
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.notify.minimumWidth
Minimum width for notification windows
Type: null or signed integer
Default: null
Declared by:
plugins.notify.stages
Animation style
Type: null or one of “fade_in_slide_out”, “fade”, “slide”, “static”
Default: null
Declared by:
plugins.notify.timeout
Default timeout for notifications
Type: null or signed integer
Default: null
Declared by:
plugins.null-ls.enable
Whether to enable null-ls.
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.package
Plugin to use for null-ls
Type: package
Default: <derivation vimplugin-null-ls.nvim-2023-07-06>
Declared by:
plugins.null-ls.border
Uses NullLsInfoBorder highlight group (see Highlight Groups).
Defines the border to use for :NullLsInfo UI window… Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: null
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.null-ls.cmd
Defines the command used to start the null-ls server. If you do not have an nvim binary available on your $PATH, you should change this to an absolute path to the binary.
default: ["nvim"]
Type: null or (list of string)
Default: null
Declared by:
plugins.null-ls.debounce
The debounce setting controls the amount of time between the last change to a buffer and the next textDocument/didChange notification. These notifications cause null-ls to generate diagnostics, so this setting indirectly controls the rate of diagnostic generation (affected by update_in_insert, described below).
Lowering debounce will result in quicker diagnostic refreshes at the cost of running diagnostic sources more frequently, which can affect performance. The default value should be enough to provide near-instantaneous feedback from most sources without unnecessary resource usage.
default: 250
Type: null or signed integer
Default: null
Declared by:
plugins.null-ls.debug
Displays all possible log messages and writes them to the null-ls log, which you can view with the command :NullLsLog. This option can slow down Neovim, so it’s strongly recommended to disable it for normal use.
debug = true is the same as setting logLevel to "trace".
default: false
Type: null or boolean
Default: null
Declared by:
plugins.null-ls.defaultTimeout
Sets the amount of time (in milliseconds) after which built-in sources will time out. Note that built-in sources can define their own timeout period and that users can override the timeout period on a per-source basis, too (see BUILTIN_CONFIG.md).
Specifying a timeout with a value less than zero will prevent commands from timing out.
default: 5000
Type: null or signed integer
Default: null
Declared by:
plugins.null-ls.diagnosticConfig
Specifies diagnostic display options for null-ls sources, as described in :help vim.diagnostic.config(). (null-ls uses separate namespaces for each source, so server-wide configuration will not work as expected.)
You can also configure diagnostic_config per built-in by using the with method, described in BUILTIN_CONFIG.md.
default: null
Type: null or (attribute set)
Default: null
Declared by:
plugins.null-ls.diagnosticsFormat
Sets the default format used for diagnostics. The plugin will replace the following special components with the relevant diagnostic information:
-
#{m}: message -
#{s}: source name (defaults tonull-lsif not specified) -
#{c}: code (if available)
For example, setting diagnostics_format to the following:
diagnostics_format = "[#{c}] #{m} (#{s})"Formats diagnostics as follows:
[2148] Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive. (shellcheck)You can also configure diagnostics_format per built-in by using the with method, described in BUILTIN_CONFIG.
default: #{m}
Type: null or string
Default: null
Declared by:
plugins.null-ls.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.null-ls.fallbackSeverity
Defines the severity used when a diagnostic source does not explicitly define a severity. See :help diagnostic-severity for available values.
default: error
Type: null or signed integer or one of “error”, “warn”, “info”, “hint”
Default: null
Declared by:
plugins.null-ls.logLevel
Enables or disables logging to file.
Plugin logs messages on several logging levels to following destinations:
-
file, can be inspected by
:NullLsLog. -
neovim’s notification area.
default: "warn"
Type: null or one of “off”, “error”, “warn”, “info”, “debug”, “trace”
Default: null
Declared by:
plugins.null-ls.notifyFormat
Sets the default format for vim.notify() messages. Can be used to customize 3rd party notification plugins like nvim-notify.
default: [null-ls] %s
Type: null or string
Default: null
Declared by:
plugins.null-ls.onAttach
Defines an on_attach callback to run whenever null-ls attaches to a buffer. If you have a common on_attach you’re using for LSP servers, you can reuse that here, use a custom callback for null-ls, or leave this undefined.
default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.onExit
Defines an on_exit callback to run when the null-ls client exits.
default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.onInit
Defines an on_init callback to run when null-ls initializes. From here, you can make changes to the client (the first argument) or initialize_result (the second argument, which as of now is not used).
default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.rootDir
Determines the root of the null-ls server. On startup, null-ls will call root_dir with the full path to the first file that null-ls attaches to.
local root_dir = function(fname)
return fname:match("my-project") and "my-project-root"
endIf root_dir returns nil, the root will resolve to the current working directory.
default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.shouldAttach
A user-defined function that controls whether to enable null-ls for a given buffer. Receives bufnr as its first argument.
To cut down potentially expensive calls, null-ls will call should_attach after its own internal checks pass, so it’s not guaranteed to run on each new buffer.
require("null-ls.nvim").setup({
should_attach = function(bufnr)
return not vim.api.nvim_buf_get_name(bufnr):match("^git://")
end,
})default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.code_actions.eslint.enable
Whether to enable eslint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.code_actions.eslint.package
Package to use for eslint by null-ls
Type: package
Default: <derivation eslint-8.44.0>
Declared by:
plugins.null-ls.sources.code_actions.eslint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.code_actions.eslint_d.enable
Whether to enable eslint_d source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.code_actions.eslint_d.package
Package to use for eslint_d by null-ls
Type: package
Default: <derivation eslint_d-12.2.1>
Declared by:
plugins.null-ls.sources.code_actions.eslint_d.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.code_actions.gitsigns.enable
Whether to enable gitsigns source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.code_actions.gitsigns.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.code_actions.shellcheck.enable
Whether to enable shellcheck source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.code_actions.shellcheck.package
Package to use for shellcheck by null-ls
Type: package
Default: <derivation shellcheck-0.9.0>
Declared by:
plugins.null-ls.sources.code_actions.shellcheck.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.code_actions.statix.enable
Whether to enable statix source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.code_actions.statix.package
Package to use for statix by null-ls
Type: package
Default: <derivation statix-0.5.6>
Declared by:
plugins.null-ls.sources.code_actions.statix.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.alex.enable
Whether to enable alex source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.alex.package
Package to use for alex by null-ls
Type: package
Default: <derivation alex-11.0.0>
Declared by:
plugins.null-ls.sources.diagnostics.alex.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.cppcheck.enable
Whether to enable cppcheck source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.cppcheck.package
Package to use for cppcheck by null-ls
Type: package
Default: <derivation cppcheck-2.11>
Declared by:
plugins.null-ls.sources.diagnostics.cppcheck.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.deadnix.enable
Whether to enable deadnix source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.deadnix.package
Package to use for deadnix by null-ls
Type: package
Default: <derivation deadnix-1.2.0>
Declared by:
plugins.null-ls.sources.diagnostics.deadnix.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.eslint.enable
Whether to enable eslint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.eslint.package
Package to use for eslint by null-ls
Type: package
Default: <derivation eslint-8.44.0>
Declared by:
plugins.null-ls.sources.diagnostics.eslint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.eslint_d.enable
Whether to enable eslint_d source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.eslint_d.package
Package to use for eslint_d by null-ls
Type: package
Default: <derivation eslint_d-12.2.1>
Declared by:
plugins.null-ls.sources.diagnostics.eslint_d.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.flake8.enable
Whether to enable flake8 source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.flake8.package
Package to use for flake8 by null-ls
Type: package
Default: <derivation python3.10-flake8-6.0.0>
Declared by:
plugins.null-ls.sources.diagnostics.flake8.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.gitlint.enable
Whether to enable gitlint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.gitlint.package
Package to use for gitlint by null-ls
Type: package
Default: <derivation gitlint-0.19.1>
Declared by:
plugins.null-ls.sources.diagnostics.gitlint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.hadolint.enable
Whether to enable hadolint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.hadolint.package
Package to use for hadolint by null-ls
Type: package
Default: <derivation hadolint-2.12.0>
Declared by:
plugins.null-ls.sources.diagnostics.hadolint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.luacheck.enable
Whether to enable luacheck source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.luacheck.package
Package to use for luacheck by null-ls
Type: package
Default: <derivation lua5.2-luacheck-1.1.0-1>
Declared by:
plugins.null-ls.sources.diagnostics.luacheck.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.mypy.enable
Whether to enable mypy source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.mypy.package
Package to use for mypy by null-ls
Type: package
Default: <derivation mypy-1.3.0>
Declared by:
plugins.null-ls.sources.diagnostics.mypy.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.protolint.enable
Whether to enable protolint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.protolint.package
Package to use for protolint by null-ls
Type: package
Default: <derivation protolint-0.37.1>
Declared by:
plugins.null-ls.sources.diagnostics.protolint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.pylint.enable
Whether to enable pylint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.pylint.package
Package to use for pylint by null-ls
Type: package
Default: <derivation pylint-2.16.2>
Declared by:
plugins.null-ls.sources.diagnostics.pylint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.shellcheck.enable
Whether to enable shellcheck source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.shellcheck.package
Package to use for shellcheck by null-ls
Type: package
Default: <derivation shellcheck-0.9.0>
Declared by:
plugins.null-ls.sources.diagnostics.shellcheck.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.statix.enable
Whether to enable statix source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.statix.package
Package to use for statix by null-ls
Type: package
Default: <derivation statix-0.5.6>
Declared by:
plugins.null-ls.sources.diagnostics.statix.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.vale.enable
Whether to enable vale source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.vale.package
Package to use for vale by null-ls
Type: package
Default: <derivation vale-2.28.0>
Declared by:
plugins.null-ls.sources.diagnostics.vale.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.diagnostics.vulture.enable
Whether to enable vulture source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.diagnostics.vulture.package
Package to use for vulture by null-ls
Type: package
Default: <derivation python3.10-vulture-2.7>
Declared by:
plugins.null-ls.sources.diagnostics.vulture.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.alejandra.enable
Whether to enable alejandra source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.alejandra.package
Package to use for alejandra by null-ls
Type: package
Default: <derivation alejandra-3.0.0>
Declared by:
plugins.null-ls.sources.formatting.alejandra.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.black.enable
Whether to enable black source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.black.package
Package to use for black by null-ls
Type: package
Default: <derivation python3.10-black-23.3.0>
Declared by:
plugins.null-ls.sources.formatting.black.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.cbfmt.enable
Whether to enable cbfmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.cbfmt.package
Package to use for cbfmt by null-ls
Type: package
Default: <derivation cbfmt-0.2.0>
Declared by:
plugins.null-ls.sources.formatting.cbfmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.eslint.enable
Whether to enable eslint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.eslint.package
Package to use for eslint by null-ls
Type: package
Default: <derivation eslint-8.44.0>
Declared by:
plugins.null-ls.sources.formatting.eslint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.eslint_d.enable
Whether to enable eslint_d source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.eslint_d.package
Package to use for eslint_d by null-ls
Type: package
Default: <derivation eslint_d-12.2.1>
Declared by:
plugins.null-ls.sources.formatting.eslint_d.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.fnlfmt.enable
Whether to enable fnlfmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.fnlfmt.package
Package to use for fnlfmt by null-ls
Type: package
Default: <derivation fnlfmt-0.3.0>
Declared by:
plugins.null-ls.sources.formatting.fnlfmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.fourmolu.enable
Whether to enable fourmolu source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.fourmolu.package
Package to use for fourmolu by null-ls
Type: package
Default: <derivation fourmolu-0.9.0.0>
Declared by:
plugins.null-ls.sources.formatting.fourmolu.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.isort.enable
Whether to enable isort source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.isort.package
Package to use for isort by null-ls
Type: package
Default: <derivation isort-5.12.0>
Declared by:
plugins.null-ls.sources.formatting.isort.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.jq.enable
Whether to enable jq source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.jq.package
Package to use for jq by null-ls
Type: package
Default: <derivation jq-1.6>
Declared by:
plugins.null-ls.sources.formatting.jq.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.markdownlint.enable
Whether to enable markdownlint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.markdownlint.package
Package to use for markdownlint by null-ls
Type: package
Default: <derivation markdownlint-cli-0.35.0>
Declared by:
plugins.null-ls.sources.formatting.markdownlint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.nixfmt.enable
Whether to enable nixfmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.nixfmt.package
Package to use for nixfmt by null-ls
Type: package
Default: <derivation nixfmt-0.5.0>
Declared by:
plugins.null-ls.sources.formatting.nixfmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.nixpkgs_fmt.enable
Whether to enable nixpkgs_fmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.nixpkgs_fmt.package
Package to use for nixpkgs_fmt by null-ls
Type: package
Default: <derivation nixpkgs-fmt-1.3.0>
Declared by:
plugins.null-ls.sources.formatting.nixpkgs_fmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.phpcbf.enable
Whether to enable phpcbf source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.phpcbf.package
Package to use for phpcbf by null-ls
Type: package
Default: <derivation php-phpcbf-3.7.1>
Declared by:
plugins.null-ls.sources.formatting.phpcbf.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.prettier.enable
Whether to enable prettier source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.prettier.package
Package to use for prettier by null-ls
Type: package
Default: <derivation prettier-3.0.0>
Declared by:
plugins.null-ls.sources.formatting.prettier.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.prettier_d_slim.enable
Whether to enable prettier_d_slim source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.prettier_d_slim.package
Package to use for prettier_d_slim by null-ls
Type: package
Default: <derivation prettier_d_slim-1.2.0>
Declared by:
plugins.null-ls.sources.formatting.prettier_d_slim.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.protolint.enable
Whether to enable protolint source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.protolint.package
Package to use for protolint by null-ls
Type: package
Default: <derivation protolint-0.37.1>
Declared by:
plugins.null-ls.sources.formatting.protolint.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.rustfmt.enable
Whether to enable rustfmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.rustfmt.package
Package to use for rustfmt by null-ls
Type: package
Default: <derivation rustfmt-1.70.0>
Declared by:
plugins.null-ls.sources.formatting.rustfmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.shfmt.enable
Whether to enable shfmt source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.shfmt.package
Package to use for shfmt by null-ls
Type: package
Default: <derivation shfmt-3.7.0>
Declared by:
plugins.null-ls.sources.formatting.shfmt.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.sqlfluff.enable
Whether to enable sqlfluff source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.sqlfluff.package
Package to use for sqlfluff by null-ls
Type: package
Default: <derivation sqlfluff-2.1.2>
Declared by:
plugins.null-ls.sources.formatting.sqlfluff.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.stylua.enable
Whether to enable stylua source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.stylua.package
Package to use for stylua by null-ls
Type: package
Default: <derivation stylua-0.18.0>
Declared by:
plugins.null-ls.sources.formatting.stylua.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sources.formatting.taplo.enable
Whether to enable taplo source, for null-ls…
Type: boolean
Default: false
Example: true
Declared by:
plugins.null-ls.sources.formatting.taplo.package
Package to use for taplo by null-ls
Type: package
Default: <derivation taplo-0.8.1>
Declared by:
plugins.null-ls.sources.formatting.taplo.withArgs
Raw Lua code to be called with the with function
Type: null or string
Default: null
Declared by:
plugins.null-ls.sourcesItems
The list of sources to enable, should be strings of lua code. Don’t use this directly
Type: null or (list of attribute set of string)
Default: null
Declared by:
plugins.null-ls.tempDir
Defines the directory used to create temporary files for sources that rely on them (a workaround used for command-based sources that do not support stdio).
To maximize compatibility, null-ls defaults to creating temp files in the same directory as the parent file. If this is causing issues, you can set it to /tmp (or another appropriate directory) here. Otherwise, there is no need to change this setting.
Note: some null-ls built-in sources expect temp files to exist within a project for context and so will not work if this option changes.
You can also configure temp_dir per built-in by using the with method, described in BUILTIN_CONFIG.md.
default: null
Type: null or string
Default: null
Declared by:
plugins.null-ls.updateInInsert
Controls whether diagnostic sources run in insert mode. If set to false, diagnostic sources will run upon exiting insert mode, which greatly improves performance but can create a slight delay before diagnostics show up. Set this to true if you don’t experience performance issues with your sources.
Note that by default, Neovim will not display updated diagnostics in insert mode. Together with the option above, you need to pass update_in_insert = true to vim.diagnostic.config for diagnostics to work as expected. See :help vim.diagnostic.config for more info.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.enable
Whether to enable nvim-autopairs.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-autopairs.enableAbbr
Trigger abbreviation.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.enableAfterQuote
Add bracket pairs after quote.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.enableBracketInQuote
Enable bracket in quote.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.enableCheckBracketLine
Check bracket in same line.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.enableMoveright
Enable moveright.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.package
Plugin to use for nvim-autopairs
Type: package
Default: <derivation vimplugin-nvim-autopairs-2023-06-18>
Declared by:
plugins.nvim-autopairs.breakUndo
Switch for basic rule break undo sequence.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.checkTs
Use treesitter to check for a pair.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.disableInMacro
Disable when recording or executing a macro.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.disableInReplaceMode
Disable in replace mode.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.disableInVisualblock
Disable when insert after visual block mode.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.disabledFiletypes
Disabled filetypes
default: [ "TelescopePrompt" "spectre_panel" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-autopairs.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.nvim-autopairs.ignoredNextChar
Regexp to ignore if it matches the next character.
default: [=[[%w%%%'%[%"%.%%$]]=]`
Type: null or string
Default: null
Declared by:
plugins.nvim-autopairs.mapBs
Map the <BS> key to delete the pair.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.mapCH
Map the <C-h> key to delete a pair.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.mapCW
Map the <C-w> key to delete a pair if possible.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.mapCr
Map the <CR> key to confirm the completion.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-autopairs.pairs
Characters to pair up
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.nvim-autopairs.tsConfig
Configuration for TreeSitter.
Default:
{
lua = [ "string" "source" ];
javascript = [ "string" "template_string" ];
};
Type: null or null or (attribute set)
Default: null
Declared by:
plugins.nvim-bqf.enable
Whether to enable nvim-bqf.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-bqf.package
Plugin to use for nvim-bqf
Type: package
Default: <derivation vimplugin-nvim-bqf-2023-06-24>
Declared by:
plugins.nvim-bqf.autoEnable
Enable nvim-bqf in quickfix window automatically.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.autoResizeHeight
Resize quickfix window height automatically. Shrink higher height to size of list in quickfix window, otherwise extend height to size of list or to default height (10).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.nvim-bqf.filter.fzf.actionFor.ctrl-c
Press ctrl-c to close quickfix window and abort fzf.
default: closeall
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.filter.fzf.actionFor.ctrl-q
Press ctrl-q to toggle sign for the selected items.
default: signtoggle
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.filter.fzf.actionFor.ctrl-t
Press ctrl-t to open up the item in a new tab.
default: tabedit
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.filter.fzf.actionFor.ctrl-v
Press ctrl-v to open up the item in a new vertical split.
default: vsplit
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.filter.fzf.actionFor.ctrl-x
Press ctrl-x to open up the item in a new horizontal split.
default: split
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.filter.fzf.extraOpts
Extra options for fzf.
default: [ "--bind" "ctrl-o:toggle-all" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-bqf.funcMap
The table for {function = key}.
Example (some default values): funcMap = { open = “<CR>”; tab = “t”; sclear = “z<Tab>”; };
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.nvim-bqf.magicWindow
Give the window magic, when the window is splited horizontally, keep the distance between the current line and the top/bottom border of neovim unchanged. It’s a bit like a floating window, but the window is indeed a normal window, without any floating attributes.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.preview.autoPreview
Enable preview in quickfix window automatically.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.preview.borderChars
Border and scroll bar chars, they respectively represent: vline, vline, hline, hline, ulcorner, urcorner, blcorner, brcorner, sbar
default: [ "│" "│" "─" "─" "╭" "╮" "╰" "╯" "█" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-bqf.preview.bufLabel
Add label of current item buffer at the end of the item line.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.preview.delaySyntax
Delay time, to do syntax for previewed buffer, unit is millisecond.
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-bqf.preview.shouldPreviewCb
A callback function to decide whether to preview while switching buffer, with (bufnr: number, qwinid: number) parameters.
Type: null or string
Default: null
Declared by:
plugins.nvim-bqf.preview.showTitle
Show the window title.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-bqf.preview.winHeight
The height of preview window for horizontal layout. Large value (like 999) perform preview window as a “full” mode.
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-bqf.preview.winVheight
The height of preview window for vertical layout.
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-bqf.preview.wrap
Wrap the line, :h wrap for detail.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.enable
Whether to enable nvim-cmp.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-cmp.package
Plugin to use for nvim-cmp
Type: package
Default: <derivation lua5.1-nvim-cmp-2023-07-10>
Declared by:
plugins.nvim-cmp.autoEnableSources
Scans the sources array and installs the plugins if they are known to nixvim.
Type: boolean
Default: true
Declared by:
plugins.nvim-cmp.completion
Completion options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.completion.autocomplete
The event to trigger autocompletion. If set to "false", then completion is only invoked manually (e.g. by calling cmp.complete).
default: [ "TextChanged" ]
Type: null or (list of string) or value false (singular enum)
Default: null
Declared by:
plugins.nvim-cmp.completion.completeopt
Like vim’s completeopt setting. In general, you don’t need to change this.
default: menu,menuone,noselect
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.completion.keywordLength
The number of characters needed to trigger auto-completion.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.completion.keywordPattern
The default keyword pattern.
default: \%(-\?\d\+\%(\.\d\+\)\?\|\h\w*\%(-\w*\)*\)
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.confirmation
Confirmation options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.confirmation.getCommitCharacters
You can append or exclude commitCharacters via this configuration option function. The commitCharacters are defined by the LSP spec.
default: function(commit_characters) return commit_characters end
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.experimental
Experimental features
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-cmp.formatting
Formatting options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.formatting.expandableIndicator
Boolean to show the ~ expandable indicator in cmp’s floating window.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.formatting.fields
An array of completion fields to specify their order.
default: [ "kind" "abbr" "menu" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-cmp.formatting.format
fun(entry: cmp.Entry, vim_item: vim.CompletedItem): vim.CompletedItem The function used to customize the appearance of the completion menu. See |complete-items|. This value can also be used to modify the dup property. NOTE: The vim.CompletedItem can contain the special properties abbr_hl_group, kind_hl_group and menu_hl_group.
default: function(_, vim_item) return vim_item end
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.mapping
This option has no description.
Type: null or (attribute set of (string or (submodule)))
Default: null
Example:
''
{
"<CR>" = "cmp.mapping.confirm({ select = true })";
"<Tab>" = {
modes = [ "i" "s" ];
action = '''
function(fallback)
if cmp.visible() then
cmp.select_next_item()
elseif luasnip.expandable() then
luasnip.expand()
elseif luasnip.expand_or_jumpable() then
luasnip.expand_or_jump()
elseif check_backspace() then
fallback()
else
fallback()
end
end
''';
};
}
''
Declared by:
plugins.nvim-cmp.mappingPresets
Mapping presets to use; cmp.mapping.preset. ${mappingPreset} will be called with the configured mappings.
Type: list of (one of “insert”, “cmdline”)
Default: [ ]
Example: "[ \"insert\" \"cmdline\" ]"
Declared by:
plugins.nvim-cmp.matching
Matching options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.matching.disallowFullfuzzyMatching
Whether to allow full-fuzzy matching.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.matching.disallowFuzzyMatching
Whether to allow fuzzy matching.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.matching.disallowPartialFuzzyMatching
Whether to allow fuzzy matching without prefix matching.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.matching.disallowPartialMatching
Whether to allow partial matching.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.matching.disallowPrefixUnmatching
Whether to allow prefix unmatching.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.performance.asyncBudget
Maximum time (in ms) an async function is allowed to run during one step of the event loop.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.performance.debounce
Sets debounce time This is the interval used to group up completions from different sources for filtering and displaying.
default: 60
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.performance.fetchingTimeout
Sets the timeout of candidate fetching process. The nvim-cmp will wait to display the most prioritized source.
default: 500
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.performance.maxViewEntries
Maximum number of items to show in the entries list.
default: 200
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.performance.throttle
Sets throttle time. This is used to delay filtering and displaying completions.
default: 30
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.preselect
-
“Item”: nvim-cmp will preselect the item that the source specified.
-
“None”: nvim-cmp will not preselect any items.
default: "Item"
Type: null or one of “Item”, “None”
Default: null
Declared by:
plugins.nvim-cmp.snippet
Snippet options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.snippet.expand
The snippet expansion function. That’s how nvim-cmp interacts with a particular snippet engine.
You may directly provide one of those four supported engines:
-
vsnip
-
luasnip
-
snippy
-
ultisnips
You can also provide a custom function:
{
__raw = \'\'
function(args)
vim.fn["vsnip#anonymous"](args.body) -- For `vsnip` users.
-- require('luasnip').lsp_expand(args.body) -- For `luasnip` users.
-- require('snippy').expand_snippet(args.body) -- For `snippy` users.
-- vim.fn["UltiSnips#Anon"](args.body) -- For `ultisnips` users.
end
\'\';
};
Type: null or (submodule) or one of “luasnip”, “snippy”, “ultisnips”, “vsnip”
Default: null
Declared by:
plugins.nvim-cmp.sorting
Sorting options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.sorting.comparators
The function to customize the sorting behavior. You can use built-in comparators via cmp.config.compare.*.
Signature: (fun(entry1: cmp.Entry, entry2: cmp.Entry): boolean | nil)[]
default: [ "offset" "exact" "score" "recently_used" "locality" "kind" "length" "order" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-cmp.sorting.priorityWeight
Each item’s original priority (given by its corresponding source) will be increased by #sources - (source_index - 1) and multiplied by priority_weight. That is, the final priority is calculated by the following formula:
final_score = orig_score + #sources - (source_index - 1 * sorting.priority_weight)
default: 2
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.sources
The sources to use. Can either be a list of sourceConfigs which will be made directly to a Lua object. Or it can be a list of lists, which will use the cmp built-in helper function cmp.config.sources.
Default: [ ]
Type: null or (list of (submodule)) or list of list of (submodule)
Default: null
Example:
''
[
{ name = "nvim_lsp"; }
{ name = "luasnip"; } #For luasnip users.
{ name = "path"; }
{ name = "buffer"; }
]
''
Declared by:
plugins.nvim-cmp.view
View options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.view.entries
The view class used to customize nvim-cmp’s appearance.
default: { name = "custom"; selection_order = "top_down"; }
Type: null or string or (attribute set)
Default: null
Declared by:
plugins.nvim-cmp.window
Windows options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.window.completion
Completion window options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.window.completion.border
Defines the border to use for nvim-cmp window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: [ "" "" "" "" "" "" "" "" ]
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.nvim-cmp.window.completion.colOffset
Offsets the completion window relative to the cursor.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.window.completion.scrollbar
Whether the scrollbar should be enabled if there are more items that fit
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-cmp.window.completion.scrolloff
Specify the window’s scrolloff option. See |‘scrolloff’|.
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.window.completion.sidePadding
The amount of padding to add on the completion window’s sides.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.window.completion.winhighlight
Specify the window’s winhighlight option. See |nvim_open_win|.
default: Normal:Pmenu,FloatBorder:Pmenu,CursorLine:PmenuSel,Search:None
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.window.completion.zindex
The completion window’s zindex. See |nvim_open_win|.
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-cmp.window.documentation
Documentation window options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-cmp.window.documentation.border
Defines the border to use for nvim-cmp documentation window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: [ "" "" "" " " "" "" "" " " ]
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.nvim-cmp.window.documentation.maxHeight
The documentation window’s max height.
default: math.floor(40 * (40 / vim.o.lines))
Type: null or signed integer or string
Default: null
Declared by:
plugins.nvim-cmp.window.documentation.maxWidth
The documentation window’s max width.
default: math.floor40 * 2) * (vim.o.columns / (40 * 2 * 16 / 9)
Type: null or signed integer or string
Default: null
Declared by:
plugins.nvim-cmp.window.documentation.winhighlight
Specify the window’s winhighlight option. See |nvim_open_win|.
default: FloatBorder:NormalFloat
Type: null or string
Default: null
Declared by:
plugins.nvim-cmp.window.documentation.zindex
The completion window’s zindex. See |nvim_open_win|.
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-colorizer.enable
Whether to enable nvim-colorizer.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-colorizer.package
Plugin to use for nvim-colorizer
Type: package
Default: <derivation vimplugin-nvim-colorizer.lua-2023-02-27>
Declared by:
plugins.nvim-colorizer.bufTypes
Buftype value is fetched by vim.bo.buftype
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-colorizer.fileTypes
Enable and/or configure highlighting for certain filetypes
Type: null or (list of (string or (submodule)))
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions
Default options
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.AARRGGBB
0xAARRGGBB hex codes
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.RGB
#RGB hex codes
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.RRGGBB
#RRGGBB hex codes
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.RRGGBBAA
#RRGGBBAA hex codes
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.css
Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.css_fn
Enable all CSS functions: rgb_fn, hsl_fn
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.hsl_fn
CSS hsl() and hsla() functions
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.mode
Set the display mode
Type: null or one of “foreground”, “background”, “virtualtext”
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.names
“Name” codes like Blue or blue
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.rgb_fn
CSS rgb() and rgba() functions
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.sass.enable
Enable sass colors
Type: null or boolean
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.sass.parsers
sass parsers settings
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.tailwind
Enable tailwind colors
Type: null or boolean or one of “normal”, “lsp”, “both”
Default: null
Declared by:
plugins.nvim-colorizer.userDefaultOptions.virtualtext
Set the virtualtext character (only used when mode is set to ‘virtualtext’)
Type: null or string
Default: null
Declared by:
plugins.nvim-jdtls.enable
Whether to enable nvim-jdtls.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-jdtls.package
Plugin to use for nvim-jdtls
Type: package
Default: <derivation vimplugin-nvim-jdtls-2023-07-09>
Declared by:
plugins.nvim-jdtls.cmd
The command that starts the language server.
You should either set a value for this option, or, you can instead set the data (and configuration) options.
plugins.nvim-jdtls = {
enable = true;
cmd = [
"$\{pkgs.jdt-language-server}/bin/jdt-language-server"
"-data" "/path/to/your/workspace"
"-configuration" "/path/to/your/configuration"
"-foo" "bar"
];
};
Or,
plugins.nvim-jdtls = {
enable = true;
data = "/path/to/your/workspace";
configuration = "/path/to/your/configuration";
};
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-jdtls.configuration
Path to the configuration file.
Type: null or string
Default: null
Example: "/home/YOUR_USERNAME/.cache/jdtls/config"
Declared by:
plugins.nvim-jdtls.data
eclipse.jdt.ls stores project specific data within the folder set via the -data flag. If you’re using eclipse.jdt.ls with multiple different projects you must use a dedicated data directory per project.
Type: null or string
Default: null
Example: "/home/YOUR_USERNAME/.cache/jdtls/workspace"
Declared by:
plugins.nvim-jdtls.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.nvim-jdtls.initOptions
Language server initializationOptions You need to extend the bundles with paths to jar files if you want to use additional eclipse.jdt.ls plugins.
If you don’t plan on using the debugger or other eclipse.jdt.ls plugins, ignore this option
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-jdtls.rootDir
This is the default if not provided, you can remove it. Or adjust as needed. One dedicated LSP server & client will be started per unique root_dir
default: { __raw = "require('jdtls.setup').find_root({'.git', 'mvnw', 'gradlew'})"; }
Type: null or string or (submodule)
Default: null
Declared by:
plugins.nvim-jdtls.settings
Here you can configure eclipse.jdt.ls specific settings See https://github.com/eclipse/eclipse.jdt.ls/wiki/Running-the-JAVA-LS-server-from-the-command-line#initialize-request for a list of options.
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-lightbulb.enable
Whether to enable nvim-lightbulb, showing available code actions.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-lightbulb.package
Plugin to use for nvim-lightbulb
Type: package
Default: <derivation vimplugin-nvim-lightbulb-2023-07-08>
Declared by:
plugins.nvim-lightbulb.autocmd.enabled
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-lightbulb.autocmd.events
default: ["CursorHold" "CursorHoldI"]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-lightbulb.autocmd.pattern
default: ["*"]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-lightbulb.float.enabled
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-lightbulb.float.text
Text to show in the popup float
default: 💡
Type: null or string
Default: null
Declared by:
plugins.nvim-lightbulb.float.winOpts
Options for the floating window (see |vim.lsp.util.open_floating_preview| for more information)
default: {}
Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.nvim-lightbulb.ignore
LSP client names to ignore
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-lightbulb.sign.enabled
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-lightbulb.sign.priority
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-lightbulb.statusText.enabled
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-lightbulb.statusText.text
Text to provide when code actions are available
default: 💡
Type: null or string
Default: null
Declared by:
plugins.nvim-lightbulb.statusText.textUnavailable
Text to provide when no actions are available
default: ``
Type: null or string
Default: null
Declared by:
plugins.nvim-lightbulb.virtualText.enabled
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-lightbulb.virtualText.hlMode
highlight mode to use for virtual text (replace, combine, blend), see :help nvim_buf_set_extmark() for reference
default: replace
Type: null or string
Default: null
Declared by:
plugins.nvim-lightbulb.virtualText.text
Text to show at virtual text
default: 💡
Type: null or string
Default: null
Declared by:
plugins.nvim-osc52.enable
Whether to enable nvim-osc52, a plugin to use OSC52 sequences to copy/paste.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-osc52.package
Plugin to use for nvim-osc52
Type: package
Default: <derivation vimplugin-nvim-osc52-2023-05-15>
Declared by:
plugins.nvim-osc52.keymaps.enable
Whether to enable keymaps for copying using OSC52.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-osc52.keymaps.copy
Copy into the system clipboard using OSC52
Type: string
Default: "<leader>y"
Declared by:
plugins.nvim-osc52.keymaps.copyLine
Copy line into the system clipboard using OSC52
Type: string
Default: "<leader>yy"
Declared by:
plugins.nvim-osc52.keymaps.copyVisual
Copy visual selection into the system clipboard using OSC52
Type: string
Default: "<leader>y"
Declared by:
plugins.nvim-osc52.keymaps.silent
Wether nvim-osc52 keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.nvim-osc52.maxLength
Maximum length of selection (0 for no limit)
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-osc52.silent
Disable message on successful copy
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-osc52.trim
Trim text before copy
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.enable
Whether to enable nvim-tree.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-tree.package
Plugin to use for nvim-tree
Type: package
Default: <derivation vimplugin-nvim-tree.lua-2023-07-09>
Declared by:
plugins.nvim-tree.actions
Configuration for various actions.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.changeDir
vim |current-directory| behaviour.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.changeDir.enable
Change the working directory when changing directories in the tree.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.changeDir.global
Use :cd instead of :lcd when changing directories. Consider that this might cause issues with the |nvim-tree.sync_root_with_cwd| option.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.changeDir.restrictAboveCwd
Restrict changing to a directory above the global current working directory.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.expandAll
Configuration for expand_all behaviour.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.expandAll.exclude
A list of directories that should not be expanded automatically. E.g [ ".git" "target" "build" ] etc.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.actions.expandAll.maxFolderDiscovery
Limit the number of folders being explored when expanding every folders. Avoids hanging neovim when running this action on very large folders.
default: 300
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.actions.filePopup
Configuration for file_popup behaviour.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.filePopup.openWinConfig
Floating window config for file_popup. See |nvim_open_win| for more details. You shouldn’t define "width" and "height" values here. They will be overridden to fit the file_popup content.
default: { col = 1; row = 1; relative = "cursor"; border = "shadow"; style = "minimal"; }
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-tree.actions.openFile
Configuration options for opening a file from nvim-tree.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.openFile.quitOnOpen
Closes the explorer when opening a file. It will also disable preventing a buffer overriding the tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.openFile.resizeWindow
Resizes the tree when opening a file.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.removeFile
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.removeFile.closeWindow
Close any window displaying a file when removing the file from the tree.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.useSystemClipboard
A boolean value that toggle the use of system clipboard when copy/paste function are invoked. When enabled, copied text will be stored in registers ‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.windowPicker
Window picker configuration.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.actions.windowPicker.enable
Enable the feature. If the feature is not enabled, files will open in window from which you last opened the tree.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.actions.windowPicker.chars
A string of chars used as identifiers by the window picker.
default: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.actions.windowPicker.exclude
Table of buffer option names mapped to a list of option values that indicates to the picker that the buffer’s window should not be selectable.
default: { filetype = [ "notify" "packer" "qf" "diff" "fugitive" "fugitiveblame" ]; buftype = [ "nofile" "terminal" "help" ]; };
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.nvim-tree.actions.windowPicker.picker
Change the default window picker, can be a string "default" or a function. The function should return the window id that will open the node, or nil if an invalid window is picked or user cancelled the action.
This can be both a string or a function (see example below). picker = { __raw = “require(‘window-picker’).pick_window”; };
default: default
Type: null or string or (submodule)
Default: null
Declared by:
plugins.nvim-tree.autoClose
Automatically close
Type: boolean
Default: false
Declared by:
plugins.nvim-tree.autoReloadOnWrite
Reloads the explorer every time a buffer is written to.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.diagnostics
Show LSP and COC diagnostics in the signcolumn Note that the modified sign will take precedence over the diagnostics signs.
NOTE: it will use the default diagnostic color groups to highlight the signs. If you wish to customize, you can override these groups:
-
NvimTreeLspDiagnosticsError -
NvimTreeLspDiagnosticsWarning -
NvimTreeLspDiagnosticsInformation -
NvimTreeLspDiagnosticsHint
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.diagnostics.enable
Enable/disable the feature.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.diagnostics.debounceDelay
Idle milliseconds between diagnostic event and update.
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.diagnostics.icons
Icons for diagnostic severity.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.diagnostics.icons.error
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.diagnostics.icons.hint
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.diagnostics.icons.info
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.diagnostics.icons.warning
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.diagnostics.severity
Severity for which the diagnostics will be displayed. See |diagnostic-severity|.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.diagnostics.severity.max
Maximum severity.
default: "error"
Type: null or one of “error”, “warn”, “info”, “hint”
Default: null
Declared by:
plugins.nvim-tree.diagnostics.severity.min
Minimum severity.
default: "hint"
Type: null or one of “error”, “warn”, “info”, “hint”
Default: null
Declared by:
plugins.nvim-tree.diagnostics.showOnDirs
Show diagnostic icons on parent directories.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.diagnostics.showOnOpenDirs
Show diagnostics icons on directories that are open. Only relevant when diagnostics.showOnDirs is `true
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.disableNetrw
Disable netrw
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.nvim-tree.filesystemWatchers
Will use file system watcher (libuv fs_event) to watch the filesystem for changes. Using this will disable BufEnter / BufWritePost events in nvim-tree which were used to update the whole tree. With this feature, the tree will be updated only for the appropriate folder change, resulting in better performance.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.filesystemWatchers.enable
Enable / disable the feature.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.filesystemWatchers.debounceDelay
Idle milliseconds between filesystem change and action.
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.filesystemWatchers.ignoreDirs
List of vim regex for absolute directory paths that will not be watched. Backslashes must be escaped e.g. "my-project/\\.build$". See |string-match|. Useful when path is not in .gitignore or git integration is disabled.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.filters
Filtering options.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.filters.custom
Custom list of vim regex for file/directory names that will not be shown. Backslashes must be escaped e.g. “^\.git”. See |string-match|. Toggle via the toggle_custom action, default mapping U.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.filters.dotfiles
Do not show dotfiles: files starting with a . Toggle via the toggle_dotfiles action, default mapping H.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.filters.exclude
List of directories or files to exclude from filtering: always show them. Overrides git.ignore, filters.dotfiles and filters.custom.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.filters.gitClean
Do not show files with no git status. This will show ignored files when |nvim-tree.git.ignore| is set, as they are effectively dirty. Toggle via the toggle_git_clean action, default mapping C.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.filters.noBuffer
Do not show files that have no listed buffer. Toggle via the toggle_no_buffer action, default mapping B. For performance reasons this may not immediately update on buffer delete/wipe. A reload or filesystem event will result in an update.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.git
Git integration with icons and colors.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.git.enable
Enable / disable the feature.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.git.ignore
Ignore files based on .gitignore. Requires git.enable to be true. Toggle via the toggle_git_ignored action, default mapping I.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.git.showOnDirs
Show status icons of children when directory itself has no status icon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.git.showOnOpenDirs
Show status icons of children on directories that are open. Only relevant when git.showOnDirs is true.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.git.timeout
Kills the git process after some time if it takes too long.
default: 400
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.hijackCursor
Keeps the cursor on the first letter of the filename when moving in the tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.hijackDirectories
Hijacks new directory buffers when they are opened (:e dir).
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.hijackDirectories.enable
Enable the feature. Disable this option if you use vim-dirvish or dirbuf.nvim. If hijackNetrw and disableNetrw are false, this feature will be disabled.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.hijackDirectories.autoOpen
Opens the tree if the tree was previously closed.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.hijackNetrw
Hijack netrw
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.hijackUnnamedBufferWhenOpening
Opens in place of the unnamed buffer if it’s empty.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.ignoreBufferOnSetup
Will ignore the buffer, when deciding to open the tree on setup.
Type: boolean
Default: false
Declared by:
plugins.nvim-tree.ignoreFtOnSetup
List of filetypes that will prevent open_on_setup to open. You can use this option if you don’t want the tree to open in some scenarios (eg using vim startify).
Type: list of string
Default: [ ]
Declared by:
plugins.nvim-tree.liveFilter
Configurations for the live_filtering feature. The live filter allows you to filter the tree nodes dynamically, based on regex matching (see |vim.regex|). This feature is bound to the f key by default. The filter can be cleared with the F key by default.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.liveFilter.alwaysShowFolders
Whether to filter folders or not.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.liveFilter.prefix
Prefix of the filter displayed in the buffer.
default: [FILTER]:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.log
Configuration for diagnostic logging.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.log.enable
Enable logging to a file $XDG_CACHE_HOME/nvim/nvim-tree.log
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.truncate
Remove existing log file at startup.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types
Specify which information to log.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.log.types.all
Everything.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.config
Options and mappings, at startup.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.copyPaste
File copy and paste actions.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.dev
Used for local development only. Not useful for users.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.diagnostics
LSP and COC processing, verbose.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.git
Git processing, verbose.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.profile
Timing of some operations.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.log.types.watcher
|nvim-tree.filesystem_watchers| processing, verbose.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.modified
Indicate which file have unsaved modification.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.modified.enable
Enable / disable the feature.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.modified.showOnDirs
Show modified indication on directory whose children are modified.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.modified.showOnOpenDirs
Show modified indication on open directories. Only relevant when modified.showOnDirs is true.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.notify
Configuration for notification.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.notify.threshold
Specify minimum notification level, uses the values from |vim.log.levels|
-
error: hard errors e.g. failure to read from the file system. -
warning: non-fatal errors e.g. unable to system open a file. -
info:information only e.g. file copy path confirmation. -
debug:not used.
default: "info"
Type: null or one of “error”, “warning”, “info”, “debug”
Default: null
Declared by:
plugins.nvim-tree.onAttach
Function ran when creating the nvim-tree buffer. This can be used to attach keybindings to the tree buffer. When onAttach is “default”, it will use the older mapping strategy, otherwise it will use the newer one.
Example: { __raw = ‘’ function(bufnr) local api = require(“nvim-tree.api”) vim.keymap.set(“n”, “<C-P>”, function() local node = api.tree.get_node_under_cursor() print(node.absolute_path) end, { buffer = bufnr, noremap = true, silent = true, nowait = true, desc = “print the node’s absolute path” }) end ‘’; }
default: default
Type: null or value “default” (singular enum) or (submodule)
Default: null
Declared by:
plugins.nvim-tree.openOnSetup
Will automatically open the tree when running setup if startup buffer is a directory, is empty or is unnamed. nvim-tree window will be focused.
Type: boolean
Default: false
Declared by:
plugins.nvim-tree.openOnSetupFile
Will automatically open the tree when running setup if startup buffer is a file. File window will be focused. File will be found if updateFocusedFile is enabled.
Type: boolean
Default: false
Declared by:
plugins.nvim-tree.preferStartupRoot
Prefer startup root directory when updating root directory of the tree. Only relevant when updateFocusedFile.updateRoot is true
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.reloadOnBufenter
Automatically reloads the tree on BufEnter nvim-tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer
UI rendering setup
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.addTrailing
Appends a trailing slash to folder names.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.fullName
Display node whose name length is wider than the width of nvim-tree window in floating window.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.groupEmpty
Compact folders that only contain a single folder into one node in the file tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.highlightGit
Enable file highlight for git attributes using NvimTreeGit* highlight groups. Requires nvim-tree.git.enable This can be used with or without the icons.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.highlightModified
Highlight icons and/or names for modified files using the NvimTreeModified highlight group. Requires nvim-tree.modified.enable This can be used with or without the icons.
default: "none"
Type: null or one of “none”, “icon”, “name”, “all”
Default: null
Declared by:
plugins.nvim-tree.renderer.highlightOpenedFiles
Highlight icons and/or names for opened files using the NvimTreeOpenedFile highlight group.
default: "none"
Type: null or one of “none”, “icon”, “name”, “all”
Default: null
Declared by:
plugins.nvim-tree.renderer.icons
Configuration options for icons.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.gitPlacement
Place where the git icons will be rendered. Can be "after" or "before" filename (after the file/folders icons) or "signcolumn" (requires |nvim-tree.view.signcolumn| enabled). Note that the diagnostic signs and the modified sign will take precedence over the git signs.
default: "before"
Type: null or one of “after”, “before”, “signcolumn”
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs
Configuration options for icon glyphs.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.default
Glyph for files. Will be overridden by nvim-web-devicons if available.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder
Glyphs for directories.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.arrowClosed
Arrow glyphs for closed directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.arrowOpen
Arrow glyphs for open directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.default
Default glyph for directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.empty
Glyph for empty directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.emptyOpen
Glyph for open empty directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.open
Glyph for open directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.symlink
Glyph for symlink directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.folder.symlinkOpen
Glyph for open symlink directories.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git
Glyphs for git status.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.deleted
Glyph for deleted nodes.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.ignored
Glyph for deleted nodes.
default: ◌
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.renamed
Glyph for renamed nodes.
default: ➜
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.staged
Glyph for staged nodes.
default: ✓
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.unmerged
Glyph for unmerged nodes.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.unstaged
Glyph for unstaged nodes.
default: ✗
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.git.untracked
Glyph for untracked nodes.
default: ★
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.modified
Icon to display for modified files.
default: ●
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.glyphs.symlink
Glyph for symlinks to files.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.modifiedPlacement
Place where the modified icon will be rendered. Can be "after" or "before" filename (after the file/folders icons) or "signcolumn" (requires |nvim-tree.view.signcolumn| enabled).
default: "after"
Type: null or one of “after”, “before”, “signcolumn”
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.padding
Inserted between icon and filename.
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show
Configuration options for showing icon types.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show.file
Show an icon before the file name. nvim-web-devicons will be used if available.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show.folder
Show an icon before the folder name.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show.folderArrow
Show a small arrow before the folder node. Arrow will be a part of the node when using |renderer.indent_markers|.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show.git
Show a git status icon, see |renderer.icons.git_placement| Requires git.enable = true
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.show.modified
Show a modified icon, see |renderer.icons.modified_placement| Requires |modified.enable| = true
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.symlinkArrow
Used as a separator between symlinks’ source and target.
default: ➛
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.icons.webdevColors
Use the webdev icon colors, otherwise NvimTreeFileIcon.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers
Configuration options for tree indent markers.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.enable
Display indent markers when folders are open
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons
Icons shown before the file/directory. Length 1.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons.bottom
default: ─
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons.corner
default: └
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons.edge
default: │
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons.item
default: │
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.icons.none
default:
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.renderer.indentMarkers.inlineArrows
Display folder arrows in the same column as indent marker when using |renderer.icons.show.folder_arrow|.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.renderer.indentWidth
Number of spaces for an each tree nesting level. Minimum 1.
default: 2
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.renderer.rootFolderLabel
In what format to show root folder. See :help filename-modifiers for available string options.
This can also be a function(root_cwd) which is passed the absolute path of the root folder and should return a string. e.g.
rootFolderLabel = { __raw = ‘’ my_root_folder_label = function(path) return “…/” … vim.fn.fnamemodify(path, “:t”) end ‘’; };
default: :~:s?$?/..?
Type: null or string or (submodule)
Default: null
Declared by:
plugins.nvim-tree.renderer.specialFiles
A list of filenames that gets highlighted with NvimTreeSpecialFile.
default: [ "Cargo.toml" "Makefile" "README.md" "readme.md" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.renderer.symlinkDestination
Whether to show the destination of the symlink.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.respectBufCwd
Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.rootDirs
Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.selectPrompts
Use |vim.ui.select| style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.sortBy
Changes how files within the same directory are sorted. Can be one of name, case_sensitive, modification_time, extension or a function. Type: string | function(nodes), Default: "name"
Function is passed a table of nodes to be sorted, each node containing:
-
absolute_path:string -
executable:boolean -
extension:string -
link_to:string -
name:string -
type:"directory"|"file"|"link"
Example: sort by name length: sortBy = { __raw = ‘’ local sort_by = function(nodes) table.sort(nodes, function(a, b) return #a.name < #b.name end) end ‘’; };
default: name
Type: null or one of “name”, “case_sensitive”, “modification_time”, “extension” or (submodule)
Default: null
Declared by:
plugins.nvim-tree.syncRootWithCwd
Changes the tree root directory on DirChanged and refreshes the tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.systemOpen
Open a file or directory in your preferred application.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.systemOpen.args
Optional argument list.
Leave empty for OS specific default: Windows: { "/c", "start", '""' }
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.systemOpen.cmd
The open command itself.
Leave empty for OS specific default: UNIX: "xdg-open" macOS: "open" Windows: "cmd"
default: ``
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.tab
Configuration for tab behaviour.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.tab.sync
Configuration for syncing nvim-tree across tabs.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.tab.sync.close
Closes the tree across all tabpages when the tree is closed.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.tab.sync.ignore
List of filetypes or buffer names on new tab that will prevent |nvim-tree.tab.sync.open| and |nvim-tree.tab.sync.close|
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.tab.sync.open
Opens the tree automatically when switching tabpage or opening a new tabpage if the tree was previously open.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.trash
Configuration options for trashing.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.trash.cmd
The command used to trash items (must be installed on your system). The default is shipped with glib2 which is a common linux package. Only available for UNIX.
default: gio trash
Type: null or string
Default: null
Declared by:
plugins.nvim-tree.ui
General UI configuration.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.ui.confirm
Confirmation prompts.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.ui.confirm.remove
Prompt before removing.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.ui.confirm.trash
Prompt before trashing.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.updateFocusedFile
Update the focused file on BufEnter, un-collapses the folders recursively until it finds the file.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.updateFocusedFile.enable
Enable this feature.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.updateFocusedFile.ignoreList
List of buffer names and filetypes that will not update the root dir of the tree if the file isn’t found under the current root directory. Only relevant when updateFocusedFile.updateRoot and updateFocusedFile.enable are true.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.nvim-tree.updateFocusedFile.updateRoot
Update the root directory of the tree if the file is not under current root directory. It prefers vim’s cwd and root_dirs. Otherwise it falls back to the folder containing the file. Only relevant when updateFocusedFile.enable is true
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.centralizeSelection
When entering nvim-tree, reposition the view so that the current node is initially centralized, see |zz|.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.cursorline
Enable |cursorline| in the tree window.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.debounceDelay
Idle milliseconds before some reload / refresh operations. Increase if you experience performance issues around screen refresh.
default: 15
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-tree.view.float
Configuration options for floating window.
Type: null or (submodule)
Default: null
Declared by:
plugins.nvim-tree.view.float.enable
Tree window will be floating.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.float.openWinConfig
Floating window config for file_popup. See |nvim_open_win| for more details. You shouldn’t define "width" and "height" values here. They will be overridden to fit the file_popup content.
default: { col = 1; row = 1; relative = "cursor"; border = "shadow"; style = "minimal"; }
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-tree.view.float.quitOnFocusLoss
Close the floating tree window when it loses focus.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.hideRootFolder
Hide the path of the current working directory on top of the tree.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.number
Print the line number in front of each line.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.preserveWindowProportions
Preserves window proportions when opening a file. If false, the height and width of windows other than nvim-tree will be equalized.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.relativenumber
Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line will be the line number instead of 0.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-tree.view.side
Side of the tree, can be "left", "right".
default: "left"
Type: null or one of “left”, “right”
Default: null
Declared by:
plugins.nvim-tree.view.signcolumn
Show diagnostic sign column. Value can be "yes", "auto", "no".
default: "yes"
Type: null or one of “yes”, “auto”, “no”
Default: null
Declared by:
plugins.nvim-tree.view.width
Width of the window: can be a % string, a number representing columns or a table. A table indicates that the view should be dynamically sized based on the longest line.
default: 30
Type: null or string or signed integer or (submodule)
Default: null
Declared by:
plugins.nvim-ufo.enable
Whether to enable nvim-ufo.
Type: boolean
Default: false
Example: true
Declared by:
plugins.nvim-ufo.enableGetFoldVirtText
Enable a function with lnum as a parameter to capture the virtual text for the folded lines and export the function to get_fold_virt_text field of ctx table as 6th parameter in fold_virt_text_handler
default: false
Type: null or boolean
Default: null
Declared by:
plugins.nvim-ufo.package
Plugin to use for nvim-ufo
Type: package
Default: <derivation vimplugin-nvim-ufo-2023-06-21>
Declared by:
plugins.nvim-ufo.closeFoldKinds
After the buffer is displayed (opened for the first time), close the folds whose range with kind field is included in this option. For now, ‘lsp’ provider’s standardized kinds are ‘comment’, ‘imports’ and ‘region’, run UfoInspect for details if your provider has extended the kinds.
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-ufo.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.nvim-ufo.foldVirtTextHandler
A lua function to customize fold virtual text
default: null
Type: null or string
Default: null
Declared by:
plugins.nvim-ufo.openFoldHlTimeout
Time in millisecond between the range to be highlgihted and to be cleared while opening the folded line, 0 value will disable the highlight
default: 400
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-ufo.preview.mappings
Mappings for preview window
Type: null or (attribute set)
Default: null
Declared by:
plugins.nvim-ufo.preview.winConfig.border
Defines the border to use for preview window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: rounded
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.nvim-ufo.preview.winConfig.maxheight
The max height of preview window
default: 20
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-ufo.preview.winConfig.winblend
The winblend for preview window, :h winblend
default: 12
Type: null or signed integer
Default: null
Declared by:
plugins.nvim-ufo.preview.winConfig.winhighlight
The winhighlight for preview window, :h winhighlight
default: Normal:Normal
Type: null or string
Default: null
Declared by:
plugins.nvim-ufo.providerSelector
A lua function as a selector for fold providers.
default: null
Type: null or string
Default: null
Declared by:
plugins.oil.enable
Whether to enable oil.
Type: boolean
Default: false
Example: true
Declared by:
plugins.oil.package
Plugin to use for oil
Type: package
Default: <derivation vimplugin-oil.nvim-2023-06-30>
Declared by:
plugins.oil.bufOptions.bufhidden
default: hide
Type: null or string
Default: null
Declared by:
plugins.oil.bufOptions.buflisted
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.columns.atime.enable
Whether to enable the atime column. Last access time of the file.
Adapters: files
Type: boolean
Default: false
Declared by:
plugins.oil.columns.atime.format
Format string (see :help strftime)
Type: null or string
Default: null
Declared by:
plugins.oil.columns.atime.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.birthtime.enable
Whether to enable the birthtime column. The time the file was created.
Adapters: files
Type: boolean
Default: false
Declared by:
plugins.oil.columns.birthtime.format
Format string (see :help strftime)
Type: null or string
Default: null
Declared by:
plugins.oil.columns.birthtime.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.ctime.enable
Whether to enable the ctime column. Change timestamp of the file.
Adapters: files
Type: boolean
Default: false
Declared by:
plugins.oil.columns.ctime.format
Format string (see :help strftime)
Type: null or string
Default: null
Declared by:
plugins.oil.columns.ctime.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.icon.enable
Whether to enable the icon column. An icon for the entry’s type (requires nvim-web-devicons).
Adapters: *
Type: boolean
Default: false
Declared by:
plugins.oil.columns.icon.defaultFile
Fallback icon for files when nvim-web-devicons returns nil.
Type: null or string
Default: null
Declared by:
plugins.oil.columns.icon.directory
Icon for directories.
Type: null or string
Default: null
Declared by:
plugins.oil.columns.icon.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.mtime.enable
Whether to enable the mtime column. Last modified time of the file.
Adapters: files
Type: boolean
Default: false
Declared by:
plugins.oil.columns.mtime.format
Format string (see :help strftime)
Type: null or string
Default: null
Declared by:
plugins.oil.columns.mtime.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.permissions.enable
Whether to enable the perimissions column. Access permissions of the file.
Adapters: files, ssh Editable: this column is read/write
Type: boolean
Default: false
Declared by:
plugins.oil.columns.permissions.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.size.enable
Whether to enable the size column. The size of the file.
Adapters: files, ssh
Type: boolean
Default: false
Declared by:
plugins.oil.columns.size.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.type.enable
Whether to enable the type column. The type of the entry (file, directory, link, etc).
Adapters: *
Type: boolean
Default: false
Declared by:
plugins.oil.columns.type.highlight
A string or a lua function (fun(value: string): string). Highlight group, or function that returns a highlight group.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.oil.columns.type.icons
Mapping of entry type to icon.
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.oil.defaultFileExplorer
Oil will take over directory buffers (e.g. vim . or :e src/.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.oil.deleteToTrash
Deleted files will be removed with the trash_command (below).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.oil.float.border
Defines the border to use for oil.open_float. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: rounded
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.oil.float.maxHeight
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.oil.float.maxWidth
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.oil.float.padding
Padding around the floating window.
default: 2
Type: null or signed integer
Default: null
Declared by:
plugins.oil.float.winOptions.winblend
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.oil.keymaps
Keymaps in oil buffer. Can be any value that vim.keymap.set accepts OR a table of keymap options with a callback (e.g. { callback = function() … end, desc = “”, nowait = true }) Additionally, if it is a string that matches “actions.<name>”, it will use the mapping at require(“oil.actions”).<name>
Set to false to remove a keymap. See :help oil-actions for a list of all available actions.
default: see documentation
Type: null or (attribute set)
Default: null
Declared by:
plugins.oil.preview.border
Defines the border to use for oil. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: rounded
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.oil.preview.height
Optionally define an integer/float for the exact height of the preview window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.oil.preview.maxHeight
Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. maxHeight = [80 0.9] means “the lesser of 80 columns or 90% of total”.
default: 0.9
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.preview.maxWidth
Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. maxWidth = [100 0.8] means “the lesser of 100 columns or 80% of total”.
default: 0.9
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.preview.minHeight
Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. minHeight = [5 0.1] means “the greater of 5 columns or 10% of total”.
default: [5 0.1]
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.preview.minWidth
Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. minWidth = [40 0.4] means “the greater of 40 columns or 40% of total”.
default: [40 0.4]
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.preview.width
Optionally define an integer/float for the exact width of the preview window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.oil.preview.winOptions.winblend
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.oil.progress.border
Defines the border to use for oil. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: rounded
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.oil.progress.height
Optionally define an integer/float for the exact height of the preview window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.oil.progress.maxHeight
Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. maxHeight = [80 0.9] means “the lesser of 80 columns or 90% of total”.
default: 0.9
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.progress.maxWidth
Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. maxWidth = [100 0.8] means “the lesser of 100 columns or 80% of total”.
default: 0.9
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.progress.minHeight
Height dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. minHeight = [5 0.1] means “the greater of 5 columns or 10% of total”.
default: [5 0.1]
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.progress.minWidth
Width dimensions can be integers or a float between 0 and 1 (e.g. 0.4 for 40%). Can be a single value or a list of mixed integer/float types. minWidth = [40 0.4] means “the greater of 40 columns or 40% of total”.
default: [40 0.4]
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive))
Default: null
Declared by:
plugins.oil.progress.minimizedBorder
Defines the border to use for oil floating progress window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: none
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.oil.progress.width
Optionally define an integer/float for the exact width of the preview window.
Type: null or signed integer or integer or floating point number between 0.0 and 1.0 (both inclusive)
Default: null
Declared by:
plugins.oil.progress.winOptions.winblend
default: 0
Type: null or signed integer
Default: null
Declared by:
plugins.oil.promptSaveOnSelectNewEntry
Selecting a new/moved/renamed file or directory will prompt you to save changes first.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.oil.restoreWinOptions
Restore window options to previous values when leaving an oil buffer
default: true
Type: null or boolean
Default: null
Declared by:
plugins.oil.skipConfirmForSimpleEdits
Skip the confirmation popup for simple operations.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.trashCommand
Change this to customize the command used when deleting to trash.
default: trash-put
Type: null or string
Default: null
Declared by:
plugins.oil.useDefaultKeymaps
Set to false to disable all of the default keymaps.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.oil.viewOptions.isAlwaysHidden
This function defines what will never be shown, even when show_hidden is set.
default: function(name, bufnr) return false end
Type: null or string
Default: null
Declared by:
plugins.oil.viewOptions.isHiddenFile
This function defines what is considered a ‘hidden’ file.
default: function(name, bufnr) return vim.startswith(name, ".") end
Type: null or string
Default: null
Declared by:
plugins.oil.viewOptions.showHidden
Show files and directories that start with “.”
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.winOptions.concealcursor
default: n
Type: null or string
Default: null
Declared by:
plugins.oil.winOptions.conceallevel
default: 3
Type: null or signed integer
Default: null
Declared by:
plugins.oil.winOptions.cursorcolumn
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.winOptions.foldcolumn
default: 0
Type: null or string
Default: null
Declared by:
plugins.oil.winOptions.list
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.winOptions.signcolumn
default: no
Type: null or string
Default: null
Declared by:
plugins.oil.winOptions.spell
default: false
Type: null or boolean
Default: null
Declared by:
plugins.oil.winOptions.wrap
default: false
Type: null or boolean
Default: null
Declared by:
plugins.openscad.enable
Whether to enable openscad.nvim, a plugin to manage OpenSCAD files.
Type: boolean
Default: false
Example: true
Declared by:
plugins.openscad.package
Plugin to use for openscad.nvim
Type: package
Default: <derivation vimplugin-openscad.nvim-2023-06-19>
Declared by:
plugins.openscad.autoOpen
default: false
Type: null or boolean
Default: null
Declared by:
plugins.openscad.cheatsheetWindowBlend
default: 15
Type: null or integer between 0 and 100 (both inclusive)
Default: null
Declared by:
plugins.openscad.fuzzyFinder
fuzzy finder to find documentation
default: "skim"
Type: null or one of “skim”, “fzf”
Default: null
Declared by:
plugins.openscad.keymaps.enable
Whether to enable keymaps for openscad.
Type: boolean
Default: false
Example: true
Declared by:
plugins.openscad.keymaps.cheatsheetToggle
Toggle cheatsheet window
default: <Enter>
Type: null or string
Default: null
Declared by:
plugins.openscad.keymaps.execOpenSCADTrigger
Open file in OpenSCAD
default: <A-o>
Type: null or string
Default: null
Declared by:
plugins.openscad.keymaps.helpManualTrigger
Open offline openscad manual in pdf via zathura
default: <A-m>
Type: null or string
Default: null
Declared by:
plugins.openscad.keymaps.helpTrigger
Fuzzy find help resource
default: <A-h>
Type: null or string
Default: null
Declared by:
plugins.openscad.keymaps.topToggle
toggle htop filtered for openscad processes
default: <A-c>
Type: null or string
Default: null
Declared by:
plugins.openscad.loadSnippets
default: false
Type: null or boolean
Default: null
Declared by:
plugins.packer.enable
Whether to enable packer.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.packer.plugins
List of plugins
Type: list of (string or (submodule))
Default: [ ]
Declared by:
plugins.packer.rockPlugins
List of lua rock plugins
Type: list of (string or (attribute set))
Default: [ ]
Example:
''
[
"penlight"
"lua-resty-http"
"lpeg"
]
''
Declared by:
plugins.plantuml-syntax.enable
Whether to enable plantuml syntax support.
Type: boolean
Default: false
Example: true
Declared by:
plugins.plantuml-syntax.package
Plugin to use for plantuml-syntax
Type: package
Default: <derivation vimplugin-plantuml-syntax-2022-08-26>
Declared by:
plugins.plantuml-syntax.executableScript
Set the script to be called with makeprg, default to ‘plantuml’ in PATH
Type: null or string
Default: null
Declared by:
plugins.plantuml-syntax.setMakeprg
Set the makeprg to ‘plantuml’
Type: boolean
Default: true
Declared by:
plugins.presence-nvim.enable
Whether to enable Enable presence-nvim…
Type: boolean
Default: false
Example: true
Declared by:
plugins.presence-nvim.enableLineNumber
Displays the current line number instead of the current project.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.presence-nvim.package
Plugin to use for presence-nvim
Type: package
Default: <derivation vimplugin-presence.nvim-2023-01-29>
Declared by:
plugins.presence-nvim.autoUpdate
Update activity based on autocmd events. If false, map or manually execute :lua package.loaded.presence:update()
default: true
Type: null or boolean
Default: null
Declared by:
plugins.presence-nvim.blacklist
A list of strings or Lua patterns that disable Rich Presence if the current file name, path, or workspace matches.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.presence-nvim.buttons
Button configurations which will always appear in Rich Presence.
Can be a list of attribute sets, each with the following attributes:
label: The label of the button. e.g. "GitHub Profile".
url: The URL the button leads to. e.g. "https://github.com/<NAME>";.
Can also be a lua function: function(buffer: string, repo_url: string|nil): table)
default: []
Type: null or (submodule) or list of (submodule)
Default: null
Declared by:
plugins.presence-nvim.clientId
Use your own Discord application client id. (not recommended)
default: 793271441293967371
Type: null or string
Default: null
Declared by:
plugins.presence-nvim.debounceTimeout
Number of seconds to debounce events. (or calls to :lua package.loaded.presence:update(<filename>, true))
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.presence-nvim.editingText
String rendered when an editable file is loaded in the buffer.
Can also be a lua function: function(filename: string): string
default: Editing %s
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.presence-nvim.fileAssets
Custom file asset definitions keyed by file names and extensions.
List elements for each attribute (filetype):
name: The name of the asset shown as the title of the file in Discord.
source: The source of the asset, either an art asset key or the URL of an image asset.
Example:
{
# Use art assets uploaded in Discord application for the configured client id
js = [ "JavaScript" "javascript" ];
ts = [ "TypeScript" "typescript" ];
# Use image URLs
rs = [ "Rust" "https://www.rust-lang.org/logos/rust-logo-512x512.png" ];
go = [ "Go" "https://go.dev/blog/go-brand/Go-Logo/PNG/Go-Logo_Aqua.png" ];
};
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.presence-nvim.fileExplorerText
String rendered when browsing a file explorer.
Can also be a lua function: function(file_explorer_name: string): string
default: Browsing %s
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.gitCommitText
String rendered when committing changes in git.
Can also be a lua function: function(filename: string): string
default: Committing changes
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.lineNumberText
String rendered when enableLineNumber is set to true to display the current line number.
Can also be a lua function: function(line_number: number, line_count: number): string
default: Line %s out of %s
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.logLevel
Log messages at or above this level.
default: "null"
Type: null or one of “debug”, “info”, “warn”, “error”
Default: null
Declared by:
plugins.presence-nvim.mainImage
Main image display.
default: "neovim"
Type: null or one of “neovim”, “file”
Default: null
Declared by:
plugins.presence-nvim.neovimImageText
Text displayed when hovered over the Neovim image.
default: The One True Text Editor
Type: null or string
Default: null
Declared by:
plugins.presence-nvim.pluginManagerText
String rendered when managing plugins.
Can also be a lua function: function(plugin_manager_name: string): string
default: Managing plugins
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.readingText
String rendered when a read-only/unmodifiable file is loaded into the buffer.
Can also be a lua function: function(filename: string): string
default: Reading %s
Type: null or string or (submodule)
Default: null
Declared by:
plugins.presence-nvim.showTime
Show the timer.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.presence-nvim.workspaceText
String rendered when in a git repository.
Can also be a lua function: function(project_name: string|nil, filename: string): string
default: Working on %s
Type: null or string or (submodule)
Default: null
Declared by:
plugins.project-nvim.enable
Whether to enable project.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.project-nvim.package
Plugin to use for project-nvim
Type: package
Default: <derivation vimplugin-project.nvim-2023-04-04>
Declared by:
plugins.project-nvim.dataPath
This option has no description.
Type: null or string or (submodule)
Default: null
Declared by:
plugins.project-nvim.detectionMethods
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.project-nvim.excludeDirs
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.project-nvim.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.project-nvim.ignoreLsp
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.project-nvim.manualMode
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.project-nvim.patterns
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.project-nvim.scopeChdir
This option has no description.
Type: null or one of “global”, “tab”, “win”
Default: null
Declared by:
plugins.project-nvim.showHidden
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.project-nvim.silentChdir
This option has no description.
Type: null or boolean
Default: null
Declared by:
plugins.quickmath.enable
Whether to enable quickmath.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.quickmath.package
Plugin to use for quickmath.nvim
Type: package
Default: <derivation vimplugin-quickmath.nvim-2023-03-12>
Declared by:
plugins.quickmath.keymap.key
Keymap to run the :Quickmath command.
Type: null or string
Default: null
Declared by:
plugins.quickmath.keymap.silent
Whether the quickmath keymap should be silent.
Type: boolean
Default: false
Declared by:
plugins.rust-tools.enable
Whether to enable rust tools plugins.
Type: boolean
Default: false
Example: true
Declared by:
plugins.rust-tools.package
Plugin to use for rust-tools
Type: package
Default: <derivation vimplugin-rust-tools.nvim-2023-02-20>
Declared by:
plugins.rust-tools.crateGraph
create graph
Type: null or (submodule)
Default: null
Declared by:
plugins.rust-tools.crateGraph.enabledGraphvizBackends
List of backends found on: https://graphviz.org/docs/outputs/ Is used for input validation and autocompletion
default: null
Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.crateGraph.backend
Backend used for displaying the graph see: https://graphviz.org/docs/outputs/
default: x11
Type: null or string
Default: null
Declared by:
plugins.rust-tools.crateGraph.full
true for all crates.io and external crates, false only the local crates
default: true
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.crateGraph.output
where to store the output, nil for no output stored
default: null
Type: null or string
Default: null
Declared by:
plugins.rust-tools.executor
how to execute terminal commands
default: "termopen"
Type: null or one of “termopen”, “quickfix”
Default: null
Declared by:
plugins.rust-tools.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.rust-tools.hoverActions
hover actions
Type: null or (submodule)
Default: null
Declared by:
plugins.rust-tools.hoverActions.autoFocus
whether the hover action window gets automatically focused
default: false
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.hoverActions.border
Defines the border to use for rust-tools hover window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: [ [ "╭" "FloatBorder" ] [ "─" "FloatBorder" ] [ "╮" "FloatBorder" ] [ "│" "FloatBorder" ] [ "╯" "FloatBorder" ] [ "─" "FloatBorder" ] [ "╰" "FloatBorder" ] [ "│" "FloatBorder" ] ]
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.rust-tools.hoverActions.maxHeight
Maximal height of the hover window. null means no max.
default: null
Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.hoverActions.maxWidth
Maximal width of the hover window. null means no max.
default: null
Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.inlayHints
inlay hints
Type: null or (submodule)
Default: null
Declared by:
plugins.rust-tools.inlayHints.auto
automatically set inlay hints (type hints)
default: true
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.inlayHints.highlight
The color of the hints
default: Comment
Type: null or string
Default: null
Declared by:
plugins.rust-tools.inlayHints.maxLenAlign
whether to align to the length of the longest line in the file
default: false
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.inlayHints.maxLenAlignPadding
padding from the left if max_len_align is true
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.inlayHints.onlyCurrentLine
Only show for current line
default: false
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.inlayHints.otherHintsPrefix
prefix for all the other hints (type, chaining)
default: =>
Type: null or string
Default: null
Declared by:
plugins.rust-tools.inlayHints.parameterHintsPrefix
prefix for parameter hints
default: <-
Type: null or string
Default: null
Declared by:
plugins.rust-tools.inlayHints.rightAlign
whether to align to the extreme right or not
default: false
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.inlayHints.rightAlignPadding
padding from the right if right_align is true
default: 7
Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.inlayHints.showParameterHints
whether to show parameter hints with the inlay hints or not
default: true
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.onInitialized
Callback to execute once rust-analyzer is done initializing the workspace The callback receives one parameter indicating the health of the server: “ok” | “warning” | “error”
default: null
Type: null or string
Default: null
Declared by:
plugins.rust-tools.reloadWorkspaceFromCargoToml
Automatically call RustReloadWorkspace when writing to a Cargo.toml file.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.server
server
Type: null or (submodule)
Default: null
Declared by:
plugins.rust-tools.server.assist.emitMustUse
Whether to insert #[must_use] when generating as_ methods for enum variants.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.assist.expressionFillDefault
Placeholder expression to use for missing expressions in assists.
default value is:
"todo"Type: null or one of “todo”, “default”
Default: null
Declared by:
plugins.rust-tools.server.cachePriming.enable
Warm up caches on project load.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.cachePriming.numThreads
How many worker threads to handle priming caches. The default 0 means to pick automatically.
default value is:
0Type: null or integer or floating point number between 0 and 255 (both inclusive)
Default: null
Declared by:
plugins.rust-tools.server.cargo.autoreload
Automatically refresh project info via cargo metadata on Cargo.toml or .cargo/config.toml changes.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.cargo.buildScripts.enable
Run build scripts (build.rs) for more precise code analysis.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.cargo.buildScripts.invocationLocation
Specifies the working directory for running build scripts.
-
“workspace”: run build scripts for a workspace in the workspace’s root directory. This is incompatible with
rust-analyzer.cargo.buildScripts.invocationStrategyset toonce. -
“root”: run build scripts in the project’s root directory. This config only has an effect when
rust-analyzer.cargo.buildScripts.overrideCommandis set.
default value is:
"workspace"Type: null or one of “workspace”, “root”
Default: null
Declared by:
plugins.rust-tools.server.cargo.buildScripts.invocationStrategy
Specifies the invocation strategy to use when running the build scripts command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when rust-analyzer.cargo.buildScripts.overrideCommand is set.
default value is:
"per_workspace"Type: null or one of “per_workspace”, “once”
Default: null
Declared by:
plugins.rust-tools.server.cargo.buildScripts.overrideCommand
Override the command rust-analyzer uses to run build scripts and build procedural macros. The command is required to output json and should therefore include --message-format=json or a similar option.
By default, a cargo invocation will be constructed for the configured targets and features, with the following base command line:
cargo check --quiet --workspace --message-format=json --all-targets.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.cargo.buildScripts.useRustcWrapper
Use RUSTC_WRAPPER=rust-analyzer when running build scripts to avoid checking unnecessary things.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.cargo.extraEnv
Extra environment variables that will be set when running cargo, rustc or other commands within the workspace. Useful for setting RUSTFLAGS.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.rust-tools.server.cargo.features
List of features to activate.
Set this to "all" to pass --all-features to cargo.
default value is:
[]Type: null or value “all” (singular enum) or list of string
Default: null
Declared by:
plugins.rust-tools.server.cargo.noDefaultFeatures
Whether to pass --no-default-features to cargo.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.cargo.sysroot
Relative path to the sysroot, or “discover” to try to automatically find it via “rustc --print sysroot”.
Unsetting this disables sysroot loading.
This option does not take effect until rust-analyzer is restarted.
default value is:
"discover"Type: null or null or string
Default: null
Declared by:
plugins.rust-tools.server.cargo.target
Compilation target override (target triple).
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.rust-tools.server.cargo.unsetTest
Unsets #[cfg(test)] for the specified crates.
default value is:
["core"]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.check.allTargets
Check all targets and tests (--all-targets).
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.check.command
Cargo command to use for cargo check.
default value is:
"check"Type: null or string
Default: null
Declared by:
plugins.rust-tools.server.check.extraArgs
Extra arguments for cargo check.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.check.extraEnv
Extra environment variables that will be set when running cargo check. Extends rust-analyzer.cargo.extraEnv.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.rust-tools.server.check.features
List of features to activate. Defaults to rust-analyzer.cargo.features.
Set to "all" to pass --all-features to Cargo.
default value is:
nullType: null or null or value “all” (singular enum) or list of string
Default: null
Declared by:
plugins.rust-tools.server.check.invocationLocation
Specifies the working directory for running checks.
-
“workspace”: run checks for workspaces in the corresponding workspaces’ root directories. This falls back to “root” if
rust-analyzer.cargo.checkOnSave.invocationStrategyis set toonce. -
“root”: run checks in the project’s root directory. This config only has an effect when
rust-analyzer.cargo.buildScripts.overrideCommandis set.
default value is:
"workspace"Type: null or one of “workspace”, “root”
Default: null
Declared by:
plugins.rust-tools.server.check.invocationStrategy
Specifies the invocation strategy to use when running the checkOnSave command. If per_workspace is set, the command will be executed for each workspace. If once is set, the command will be executed once. This config only has an effect when rust-analyzer.cargo.buildScripts.overrideCommand is set.
default value is:
"per_workspace"Type: null or one of “per_workspace”, “once”
Default: null
Declared by:
plugins.rust-tools.server.check.noDefaultFeatures
Whether to pass --no-default-features to Cargo. Defaults to rust-analyzer.cargo.noDefaultFeatures.
default value is:
nullType: null or null or boolean
Default: null
Declared by:
plugins.rust-tools.server.check.overrideCommand
Override the command rust-analyzer uses instead of cargo check for diagnostics on save. The command is required to output json and should therefore include --message-format=json or a similar option (if your client supports the colorDiagnosticOutput experimental capability, you can use --message-format=json-diagnostic-rendered-ansi).
If you’re changing this because you’re using some tool wrapping Cargo, you might also want to change rust-analyzer.cargo.buildScripts.overrideCommand.
If there are multiple linked projects, this command is invoked for each of them, with the working directory being the project root (i.e., the folder containing the Cargo.toml).
An example command would be:
cargo check --workspace --message-format=json --all-targets.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.check.targets
Check for specific targets. Defaults to rust-analyzer.cargo.target if empty.
Can be a single target, e.g. "x86_64-unknown-linux-gnu" or a list of targets, e.g. ["aarch64-apple-darwin", "x86_64-apple-darwin"].
Aliased as "checkOnSave.targets".
default value is:
nullType: null or null or string or list of string
Default: null
Declared by:
plugins.rust-tools.server.checkOnSave
Run the check command for diagnostics on save.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.completion.autoimport.enable
Toggles the additional completions that automatically add imports when completed. Note that your client must specify the additionalTextEdits LSP client capability to truly have this feature enabled.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.completion.autoself.enable
Toggles the additional completions that automatically show method calls and field accesses with self prefixed to them when inside a method.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.completion.callable.snippets
Whether to add parenthesis and argument snippets when completing function.
default value is:
"fill_arguments"Type: null or one of “fill_arguments”, “add_parentheses”, “none”
Default: null
Declared by:
plugins.rust-tools.server.completion.postfix.enable
Whether to show postfix snippets like dbg, if, not, etc.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.completion.privateEditable.enable
Enables completions of private items and fields that are defined in the current workspace even if they are not visible at the current position.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.completion.snippets.custom
Custom completion snippets.
default value is:
{"Arc::new" = {"postfix" = "arc";
"body" = "Arc::new($\{receiver})";
"requires" = "std::sync::Arc";
"description" = "Put the expression into an `Arc`";
"scope" = "expr";
};
"Rc::new" = {"postfix" = "rc";
"body" = "Rc::new($\{receiver})";
"requires" = "std::rc::Rc";
"description" = "Put the expression into an `Rc`";
"scope" = "expr";
};
"Box::pin" = {"postfix" = "pinbox";
"body" = "Box::pin($\{receiver})";
"requires" = "std::boxed::Box";
"description" = "Put the expression into a pinned `Box`";
"scope" = "expr";
};
"Ok" = {"postfix" = "ok";
"body" = "Ok($\{receiver})";
"description" = "Wrap the expression in a `Result::Ok`";
"scope" = "expr";
};
"Err" = {"postfix" = "err";
"body" = "Err($\{receiver})";
"description" = "Wrap the expression in a `Result::Err`";
"scope" = "expr";
};
"Some" = {"postfix" = "some";
"body" = "Some($\{receiver})";
"description" = "Wrap the expression in an `Option::Some`";
"scope" = "expr";
};
}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.enable
Whether to show native rust-analyzer diagnostics.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.disabled
List of rust-analyzer diagnostics to disable.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.experimental.enable
Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.remapPrefix
Map of prefixes to be substituted when parsing diagnostic file paths. This should be the reverse mapping of what is passed to rustc as --remap-path-prefix.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.warningsAsHint
List of warnings that should be displayed with hint severity.
The warnings will be indicated by faded text or three dots in code and will not show up in the Problems Panel.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.diagnostics.warningsAsInfo
List of warnings that should be displayed with info severity.
The warnings will be indicated by a blue squiggly underline in code and a blue icon in the Problems Panel.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.files.excludeDirs
These directories will be ignored by rust-analyzer. They are relative to the workspace root, and globs are not supported. You may also need to add the folders to Code’s files.watcherExclude.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.files.watcher
Controls file watching implementation.
default value is:
"client"Type: null or one of “client”, “server”
Default: null
Declared by:
plugins.rust-tools.server.highlightRelated.breakPoints.enable
Enables highlighting of related references while the cursor is on break, loop, while, or for keywords.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.highlightRelated.exitPoints.enable
Enables highlighting of all exit points while the cursor is on any return, ?, fn, or return type arrow (->).
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.highlightRelated.references.enable
Enables highlighting of related references while the cursor is on any identifier.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.highlightRelated.yieldPoints.enable
Enables highlighting of all break points for a loop or block context while the cursor is on any async or await keywords.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.enable
Whether to show HoverActions in Rust files.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.debug.enable
Whether to show Debug action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.gotoTypeDef.enable
Whether to show Go to Type Definition action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.implementations.enable
Whether to show Implementations action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.references.enable
Whether to show References action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.actions.run.enable
Whether to show Run action. Only applies when rust-analyzer.hover.actions.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.documentation.enable
Whether to show documentation on hover.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.documentation.keywords.enable
Whether to show keyword hover popups. Only applies when rust-analyzer.hover.documentation.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.hover.links.enable
Use markdown syntax for links in hover.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.imports.granularity.enforce
Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.imports.granularity.group
How imports should be grouped into use statements.
default value is:
"crate"Type: null or one of “preserve”, “crate”, “module”, “item”
Default: null
Declared by:
plugins.rust-tools.server.imports.group.enable
Group inserted imports by the following order. Groups are separated by newlines.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.imports.merge.glob
Whether to allow import insertion to merge new imports into single path glob imports like use std::fmt::*;.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.imports.prefer.no.std
Prefer to unconditionally use imports of the core and alloc crate, over the std crate.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.imports.prefix
The path structure for newly inserted paths to use.
default value is:
"plain"Type: null or one of “plain”, “self”, “crate”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.bindingModeHints.enable
Whether to show inlay type hints for binding modes.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.chainingHints.enable
Whether to show inlay type hints for method chains.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.closingBraceHints.enable
Whether to show inlay hints after a closing } to indicate what item it belongs to.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.closingBraceHints.minLines
Minimum number of lines required before the } until the hint is shown (set to 0 or 1 to always show them).
default value is:
25Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.closureReturnTypeHints.enable
Whether to show inlay type hints for return types of closures.
default value is:
"never"Type: null or one of “always”, “never”, “with_block”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.discriminantHints.enable
Whether to show enum variant discriminant hints.
default value is:
"never"Type: null or one of “always”, “never”, “fieldless”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.enable
Whether to show inlay hints for type adjustments.
default value is:
"never"Type: null or one of “always”, “never”, “reborrow”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe
Whether to hide inlay hints for type adjustments outside of unsafe blocks.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.expressionAdjustmentHints.mode
Whether to show inlay hints as postfix ops (.* instead of *, etc).
default value is:
"prefix"Type: null or one of “prefix”, “postfix”, “prefer_prefix”, “prefer_postfix”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.lifetimeElisionHints.enable
Whether to show inlay type hints for elided lifetimes in function signatures.
default value is:
"never"Type: null or one of “always”, “never”, “skip_trivial”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.lifetimeElisionHints.useParameterNames
Whether to prefer using parameter names as the name for elided lifetime hints if possible.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.maxLength
Maximum length for inlay hints. Set to null to have an unlimited length.
default value is:
25Type: null or null or signed integer
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.parameterHints.enable
Whether to show function parameter name inlay hints at the call site.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.reborrowHints.enable
Whether to show inlay hints for compiler inserted reborrows. This setting is deprecated in favor of rust-analyzer.inlayHints.expressionAdjustmentHints.enable.
default value is:
"never"Type: null or one of “always”, “never”, “mutable”
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.renderColons
Whether to render leading colons for type hints, and trailing colons for parameter hints.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.typeHints.enable
Whether to show inlay type hints for variables.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.typeHints.hideClosureInitialization
Whether to hide inlay type hints for let statements that initialize to a closure. Only applies to closures with blocks, same as rust-analyzer.inlayHints.closureReturnTypeHints.enable.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.inlayHints.typeHints.hideNamedConstructor
Whether to hide inlay type hints for constructors.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.joinLines.joinAssignments
Join lines merges consecutive declaration and initialization of an assignment.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.joinLines.joinElseIf
Join lines inserts else between consecutive ifs.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.joinLines.removeTrailingComma
Join lines removes trailing commas.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.joinLines.unwrapTrivialBlock
Join lines unwraps trivial blocks.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.enable
Whether to show CodeLens in Rust files.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.debug.enable
Whether to show Debug lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.forceCustomCommands
Internal config: use custom client-side commands even when the client doesn’t set the corresponding capability.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.implementations.enable
Whether to show Implementations lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.location
Where to render annotations.
default value is:
"above_name"Type: null or one of “above_name”, “above_whole_item”
Default: null
Declared by:
plugins.rust-tools.server.lens.references.adt.enable
Whether to show References lens for Struct, Enum, and Union. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.references.enumVariant.enable
Whether to show References lens for Enum Variants. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.references.method.enable
Whether to show Method References lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.references.trait.enable
Whether to show References lens for Trait. Only applies when rust-analyzer.lens.enable is set.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.lens.run.enable
Whether to show Run lens. Only applies when rust-analyzer.lens.enable is set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.linkedProjects
Disable project auto-discovery in favor of explicitly specified set of projects.
Elements must be paths pointing to Cargo.toml, rust-project.json, or JSON objects in rust-project.json format.
default value is:
[]Type: null or (list of (string or attribute set of anything))
Default: null
Declared by:
plugins.rust-tools.server.lru.capacity
Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
default value is:
nullType: null or null or signed integer
Default: null
Declared by:
plugins.rust-tools.server.notifications.cargoTomlNotFound
Whether to show can't find Cargo.toml error message.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.numThreads
How many worker threads in the main loop. The default null means to pick automatically.
default value is:
nullType: null or null or signed integer
Default: null
Declared by:
plugins.rust-tools.server.procMacro.enable
Enable support for procedural macros, implies rust-analyzer.cargo.buildScripts.enable.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.procMacro.attributes.enable
Expand attribute macros. Requires rust-analyzer.procMacro.enable to be set.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.procMacro.ignored
These proc-macros will be ignored when trying to expand them.
This config takes a map of crate names with the exported proc-macro names to ignore as values.
default value is:
{}Type: null or (attribute set of anything)
Default: null
Declared by:
plugins.rust-tools.server.procMacro.server
Internal config, path to proc-macro server executable (typically, this is rust-analyzer itself, but we override this in tests).
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.rust-tools.server.references.excludeImports
Exclude imports from find-all-references.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.runnables.command
Command to be executed instead of ‘cargo’ for runnables.
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.rust-tools.server.runnables.extraArgs
Additional arguments to be passed to cargo for runnables such as tests or binaries. For example, it may be --release.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.rustc.source
Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or “discover” to try to automatically find it if the rustc-dev component is installed.
Any project which uses rust-analyzer with the rustcPrivate crates must set [package.metadata.rust-analyzer] rustc_private=true to use it.
This option does not take effect until rust-analyzer is restarted.
default value is:
nullType: null or null or string
Default: null
Declared by:
plugins.rust-tools.server.rustfmt.extraArgs
Additional arguments to rustfmt.
default value is:
[]Type: null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.rustfmt.overrideCommand
Advanced option, fully override the command rust-analyzer uses for formatting.
default value is:
nullType: null or null or (list of string)
Default: null
Declared by:
plugins.rust-tools.server.rustfmt.rangeFormatting.enable
Enables the use of rustfmt’s unstable range formatting command for the textDocument/rangeFormatting request. The rustfmt option is unstable and only available on a nightly build.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.doc.comment.inject.enable
Inject additional highlighting into doc comments.
When enabled, rust-analyzer will highlight rust source in doc comments as well as intra doc links.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.operator.enable
Use semantic tokens for operators.
When disabled, rust-analyzer will emit semantic tokens only for operator tokens when they are tagged with modifiers.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.operator.specialization.enable
Use specialized semantic tokens for operators.
When enabled, rust-analyzer will emit special token types for operator tokens instead of the generic operator token type.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.punctuation.enable
Use semantic tokens for punctuations.
When disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when they are tagged with modifiers or have a special role.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.punctuation.separate.macro.bang
When enabled, rust-analyzer will emit a punctuation semantic token for the ! of macro calls.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.punctuation.specialization.enable
Use specialized semantic tokens for punctuations.
When enabled, rust-analyzer will emit special token types for punctuation tokens instead of the generic punctuation token type.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.semanticHighlighting.strings.enable
Use semantic tokens for strings.
In some editors (e.g. vscode) semantic tokens override other highlighting grammars. By disabling semantic tokens for strings, other grammars can be used to highlight their contents.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.signatureInfo.detail
Show full signature of the callable. Only shows parameters if disabled.
default value is:
"full"Type: null or one of “full”, “parameters”
Default: null
Declared by:
plugins.rust-tools.server.signatureInfo.documentation.enable
Show documentation.
default value is:
trueType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.standalone
standalone file support setting it to false may improve startup time
default: true
Type: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.typing.autoClosingAngleBrackets.enable
Whether to insert closing angle brackets when typing an opening angle bracket of a generic argument list.
default value is:
falseType: null or boolean
Default: null
Declared by:
plugins.rust-tools.server.workspace.symbol.search.kind
Workspace symbol search kind.
default value is:
"only_types"Type: null or one of “only_types”, “all_symbols”
Default: null
Declared by:
plugins.rust-tools.server.workspace.symbol.search.limit
Limits the number of items returned from a workspace symbol search (Defaults to 128). Some clients like vs-code issue new searches on result filtering and don’t require all results to be returned in the initial search. Other clients requires all results upfront and might require a higher limit.
default value is:
128Type: null or signed integer
Default: null
Declared by:
plugins.rust-tools.server.workspace.symbol.search.scope
Workspace symbol search scope.
default value is:
"workspace"Type: null or one of “workspace”, “workspace_and_dependencies”
Default: null
Declared by:
plugins.rust-tools.serverPackage
Package to use for rust-analyzer
Type: package
Default: <derivation rust-analyzer-2023-07-03>
Declared by:
plugins.sniprun.enable
Whether to enable sniprun.
Type: boolean
Default: false
Example: true
Declared by:
plugins.sniprun.package
Plugin to use for sniprun
Type: package
Default: <derivation vimplugin-sniprun-1.3.4>
Declared by:
plugins.sniprun.borders
Defines the border to use for floating windows. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: single
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.sniprun.display
You can combo different display modes as desired and with the ‘Ok’ or ‘Err’ suffix to filter only sucessful runs (or errored-out runs respectively)
Example:
[ "Classic" # display results in the command-line area "VirtualTextOk" # display ok results as virtual text (multiline is shortened) # "VirtualText" # display results as virtual text # "TempFloatingWindow" # display results in a floating window # "LongTempFloatingWindow" # same as above, but only long results. To use with VirtualText[Ok/Err] # "Terminal" # display results in a vertical split # "TerminalWithCode" # display results and code history in a vertical split # "NvimNotify" # display with the nvim-notify plugin # "Api" # return output to a programming interface ]
default: ["Classic" "VirtualTextOk"]
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.displayOptions
Display options
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.displayOptions.notificationTimeout
Timeout for nvim_notify output.
default: 5
Type: null or signed integer
Default: null
Declared by:
plugins.sniprun.displayOptions.terminalWidth
Change the terminal display option width.
default: 45
Type: null or signed integer
Default: null
Declared by:
plugins.sniprun.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.sniprun.interpreterOptions
interpreter-specific options, see docs / :SnipInfo <name>
default: {}
Type: null or (attribute set)
Default: null
Declared by:
plugins.sniprun.liveDisplay
Display modes used in live_mode
default: ["VirtualTextOk"]
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.liveModeToggle
Live mode toggle, see Usage - Running for more info.
default: off
Type: null or string
Default: null
Declared by:
plugins.sniprun.replDisable
Disable REPL-like behavior for the given interpreters
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.replEnable
Enable REPL-like behavior for the given interpreters
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.selectedInterpreters
use those instead of the default for the current filetype
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.showNoOutput
You can use the same keys to customize whether a sniprun producing no output should display nothing or ‘(no output)’.
default: ["Classic" "TempFloatingWindow"]
Type: null or (list of string)
Default: null
Declared by:
plugins.sniprun.snipruncolors
Customize highlight groups (setting this overrides colorscheme)
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinErr
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinErr.bg
Background color
default: #881515
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinErr.ctermbg
Foreground color
default: ``
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinErr.ctermfg
Foreground color
default: DarkRed
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinErr.fg
Foreground color
default: ``
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinOk
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinOk.bg
Background color
default: #66eeff
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinOk.ctermbg
Foreground color
default: ``
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinOk.ctermfg
Foreground color
default: Cyan
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunFloatingWinOk.fg
Foreground color
default: ``
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextErr
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextErr.bg
Background color
default: #000000
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextErr.ctermbg
Foreground color
default: DarkRed
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextErr.ctermfg
Foreground color
default: Black
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextErr.fg
Foreground color
default: #881515
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextOk
Type: null or (submodule)
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextOk.bg
Background color
default: #000000
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextOk.ctermbg
Foreground color
default: Cyan
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextOk.ctermfg
Foreground color
default: Black
Type: null or string
Default: null
Declared by:
plugins.sniprun.snipruncolors.SniprunVirtualTextOk.fg
Foreground color
default: #66eeff
Type: null or string
Default: null
Declared by:
plugins.specs.enable
Whether to enable specs-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.specs.package
Plugin to use for specs-nvim
Type: package
Default: <derivation vimplugin-specs.nvim-2022-09-20>
Declared by:
plugins.specs.blend
This option has no description.
Type: signed integer
Default: 10
Declared by:
plugins.specs.color
This option has no description.
Type: null or string
Default: null
Declared by:
plugins.specs.delay
Delay in miliseconds
Type: signed integer
Default: 0
Declared by:
plugins.specs.fader
This option has no description.
Type: submodule
Default:
{
builtin = "linear_fader";
}
Declared by:
plugins.specs.fader.builtin
This option has no description.
Type: null or one of “linear_fader”, “exp_fader”, “pulse_fader”, “empty_fader”
Default: "linear_fader"
Declared by:
plugins.specs.fader.custom
This option has no description.
Type: strings concatenated with “\n”
Default: ""
Example:
''
function(blend, cnt)
if cnt > 100 then
return 80
else return nil end
end
''
Declared by:
plugins.specs.ignored_buffertypes
This option has no description.
Type: list of Concatenated string
Default:
[ "nofile" ]
Declared by:
plugins.specs.ignored_filetypes
This option has no description.
Type: list of Concatenated string
Default: [ ]
Declared by:
plugins.specs.increment
Increment in miliseconds
Type: signed integer
Default: 10
Declared by:
plugins.specs.min_jump
This option has no description.
Type: signed integer
Default: 30
Declared by:
plugins.specs.resizer
This option has no description.
Type: submodule
Default:
{
builtin = "shrink_resizer";
}
Declared by:
plugins.specs.resizer.builtin
This option has no description.
Type: null or one of “shrink_resizer”, “slide_resizer”, “empty_resizer”
Default: "shrink_resizer"
Declared by:
plugins.specs.resizer.custom
This option has no description.
Type: strings concatenated with “\n”
Default: ""
Example:
''
function(width, ccol, cnt)
if width-cnt > 0 then
return {width+cnt, ccol}
else return nil end
end
''
Declared by:
plugins.specs.show_jumps
This option has no description.
Type: boolean
Default: true
Declared by:
plugins.specs.width
This option has no description.
Type: signed integer
Default: 10
Declared by:
plugins.spider.enable
Whether to enable spider.
Type: boolean
Default: false
Example: true
Declared by:
plugins.spider.package
Plugin to use for spider
Type: package
Default: <derivation vimplugin-nvim-spider-2023-06-11>
Declared by:
plugins.spider.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.spider.keymaps.motions
Mappings for spider motions. The keys are the motion and the values are the keyboard shortcuts. The shortcut might not necessarily be the same as the motion name.
Type: attribute set of string
Default: { }
Example:
{
b = "b";
e = "e";
g = "ge";
w = "w";
}
Declared by:
plugins.spider.keymaps.silent
Whether spider keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.spider.skipInsignificantPunctuation
Whether to skip unsignificant punctuation.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.startify.enable
Whether to enable Enable startify.
Type: boolean
Default: false
Example: true
Declared by:
plugins.startify.enableSpecial
Show <empty buffer> and <quit>
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.enableUnsafe
Improves start time but reduces accuracy of the file list
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.package
Plugin to use for startify
Type: package
Default: <derivation vimplugin-vim-startify-2021-05-08>
Declared by:
plugins.startify.bookmarks
A list of files or directories to bookmark.
Type: null or (list of (string or attribute set of string))
Default: null
Example: null
Declared by:
plugins.startify.changeCmd
The default command for switching directories
Type: null or one of “cd”, “lcd”, “tcd”
Default: null
Example: null
Declared by:
plugins.startify.changeToDir
When opening a file or bookmark, change to its directory
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.changeToVcsRoot
When opening a file or bookmark, change to the root directory of the VCS
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.commands
A list of commands to execute on selection
Type: null or (list of (string or list of string or (attribute set)))
Default: null
Example: null
Declared by:
plugins.startify.customFooter
Custom footer
Type: null or string
Default: null
Example: null
Declared by:
plugins.startify.customHeader
Define your own header
Type: null or string or list of string
Default: null
Example: null
Declared by:
plugins.startify.customIndices
Use this list as indices instead of increasing numbers
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.customQuotes
Own quotes for the cowsay header
Type: null or (list of list of string)
Default: null
Example: null
Declared by:
plugins.startify.disableAtVimEnter
Don’t run Startify at Vim startup
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.filesNumber
The number of files to list
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.startify.lists
Startify display lists. If it’s a string, it’ll be interpreted as literal lua code
Type: null or (list of submodule) or string
Default: null
Example: null
Declared by:
plugins.startify.paddingLeft
Number of spaces used for left padding
Type: null or signed integer
Default: null
Example: null
Declared by:
plugins.startify.relativePath
If the file is in or below the current working directory, use a relative path
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.sessionAutoload
Load Session.vim
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.sessionBeforeSave
Commands to be executed before saving a session
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.sessionDeleteBuffers
Delete all buffers when loading or closing a session
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.sessionDir
Directory to save/load session
Type: null or string
Default: null
Example: null
Declared by:
plugins.startify.sessionNumber
Maximum number of sessions to display
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.sessionPersistence
Automatically update sessions
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.sessionRemoveLines
Lines matching any of the patterns in this list will be removed from the session file
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.sessionSaveCmds
List of cmdline commands to run when loading the session
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.sessionSaveVars
List of variables for Startify to save into the session file
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.sessionSort
Sort sessions by modification time rather than alphabetically
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.skipList
A list of regexes that is used to filter recently used files
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.skipListServer
Do not create the startify buffer if this is a Vim server instance with a name contained in this list
Type: null or (list of string)
Default: null
Example: null
Declared by:
plugins.startify.updateOldFiles
Update v:oldfiles on-the-fly, so that :Startify is always up-to-date
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.useEnv
Show environment variables in path, if their name is shorter than their value
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.startify.useUnicode
Use unicode box drawing characters for the fortune header
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.surround.enable
Whether to enable Enable surround.vim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.surround.package
Plugin to use for surround
Type: package
Default: <derivation vimplugin-vim-surround-2022-10-25>
Declared by:
plugins.tagbar.enable
Whether to enable tagbar.
Type: boolean
Default: false
Example: true
Declared by:
plugins.tagbar.package
Plugin to use for tagbar
Type: package
Default: <derivation vimplugin-tagbar-2023-04-05>
Declared by:
plugins.tagbar.extraConfig
The configuration options for tagbar without the ‘tagbar_’ prefix. Example: To set ‘tagbar_show_tag_count’ to 1, write extraConfig = { show_tag_count = true; };
Type: null or (attribute set)
Default: null
Declared by:
plugins.telescope.enable
Whether to enable telescope.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.enabledExtensions
A list of enabled extensions. Don’t use this directly
Type: list of string
Default: [ ]
Declared by:
plugins.telescope.package
Plugin to use for telescope.nvim
Type: package
Default: <derivation lua5.1-telescope.nvim-2023-07-06>
Declared by:
plugins.telescope.defaults
Telescope default configuration
Type: null or (attribute set)
Default: null
Declared by:
plugins.telescope.extensionConfig
Configuration for the extensions. Don’t use this directly
Type: attribute set of anything
Default: { }
Declared by:
plugins.telescope.extensions.file_browser.enable
Whether to enable File browser extension for telescope.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extensions.file_browser.package
Plugin to use for telescope file_browser
Type: package
Default: <derivation vimplugin-telescope-file-browser.nvim-2023-07-01>
Declared by:
plugins.telescope.extensions.file_browser.addDirs
Whether the file browser shows folders.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.autoDepth
Unlimit or set depth to auto_depth & unset grouped on prompt for file_browser.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.browseFiles
A custom lua function to override for the file browser.
default: fb_finders.browse_files
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.file_browser.browseFolders
A custom lua function to override for the folder browser.
default: fb_finders.browse_folders
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.file_browser.collapseDirs
Skip with only a single (possibly hidden) sub-dir in file_browser.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.cwd
Directory to browse folders from. vim.fn.expanded automatically.
default: vim.loop.cwd()
Type: null or string or (submodule)
Default: null
Declared by:
plugins.telescope.extensions.file_browser.cwdToPath
Whether folder browser is launched from path rather than cwd.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.depth
File tree depth to display, false for unlimited depth.
default: 1
Type: null or signed integer
Default: null
Declared by:
plugins.telescope.extensions.file_browser.dirIcon
Change the icon for a directory.
default:
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.file_browser.dirIconHl
Change the highlight group of dir icon.
default: Default
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.file_browser.displayStat
Ordered stat; see upstream for more info.
default: { date = true, size = true, mode = true }
Type: null or (attribute set of (boolean or (submodule)))
Default: null
Declared by:
plugins.telescope.extensions.file_browser.files
Start in file (true) or folder (false) browser.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.gitStatus
Show the git status of files (true if git is found).
default: true
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.grouped
Group initial sorting by directories and then files.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.hidden
Determines whether to show hidden files or not.
default: false
Type: null or boolean or (submodule)
Default: null
Declared by:
plugins.telescope.extensions.file_browser.hideParentDir
Hide ../ in the file browser.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.hijackNetrw
Use telescope file browser when opening directory paths.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.mappings
fb_actions mappings. Mappings can also be a lua function.
Type: null or (attribute set of attribute set of (string or (submodule)))
Default: null
Declared by:
plugins.telescope.extensions.file_browser.path
Directory to browse files from. vim.fn.expanded automatically.
default: vim.loop.cwd()
Type: null or string or (submodule)
Default: null
Declared by:
plugins.telescope.extensions.file_browser.promptPath
Show the current relative path from cwd as the prompt prefix.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.quiet
Surpress any notification from file_brower actions.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.respectGitignore
Induces slow-down w/ plenary finder (true if fd available).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.selectBuffer
Select current buffer if possible. May imply hidden=true.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.file_browser.theme
Custom theme, will use your global theme by default.
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.file_browser.useFd
Use fd if available over plenary.scandir.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.frecency.enable
Whether to enable frecency.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extensions.frecency.package
Plugin to use for telescope extension frecency
Type: package
Default: <derivation vimplugin-telescope-frecency.nvim-2023-06-19>
Declared by:
plugins.telescope.extensions.frecency.dbRoot
Path to parent directory of custom database location. Defaults to $XDG_DATA_HOME/nvim
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.frecency.defaultWorkspace
Default workspace tag to filter by e.g ‘CWD’ to filter by default to the current directory
Type: null or string
Default: null
Declared by:
plugins.telescope.extensions.frecency.deviconsDisabled
Disable devicons (if available)
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.frecency.ignorePatterns
Patterns in this list control which files are indexed
Type: null or (list of string)
Default: null
Declared by:
plugins.telescope.extensions.frecency.showScores
Whether to show scores generated by the algorithm in the results
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.frecency.showUnindexed
Determines if non-indexed files are included in workspace filter results
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.frecency.workspaces
this table contains mappings of workspace_tag -> workspace_directory
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.telescope.extensions.fzf-native.enable
Whether to enable Enable fzf-native.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extensions.fzf-native.package
Plugin to use for telescope extension fzf-native
Type: package
Default: <derivation vimplugin-telescope-fzf-native.nvim-2023-05-25>
Declared by:
plugins.telescope.extensions.fzf-native.caseMode
This option has no description.
Type: null or one of “smart_case”, “ignore_case”, “respect_case”
Default: null
Declared by:
plugins.telescope.extensions.fzf-native.fuzzy
Whether to fuzzy search. False will do exact matching
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.fzf-native.overrideFileSorter
Override the file sorter
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.fzf-native.overrideGenericSorter
Override the generice sorter
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.fzy-native.enable
Whether to enable Enable fzy-native.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extensions.fzy-native.overrideFileSorter
Override the file sorter
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.fzy-native.overrideGenericSorter
Override the generice sorter
Type: null or boolean
Default: null
Declared by:
plugins.telescope.extensions.media_files.enable
Whether to enable Enable media_files extension for telescope.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extensions.media_files.package
Plugin to use for telescope extension media_files
Type: package
Default: <derivation vimplugin-telescope-media-files.nvim-2023-02-19>
Declared by:
plugins.telescope.extensions.media_files.filetypes
This option has no description.
Type: null or (list of string)
Default: null
Declared by:
plugins.telescope.extensions.media_files.find_cmd
This option has no description.
Type: null or string
Default: null
Example: "\"rg\""
Declared by:
plugins.telescope.extensions.project-nvim.enable
Whether to enable project-nvim telescope extension.
Type: boolean
Default: false
Example: true
Declared by:
plugins.telescope.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.telescope.highlightTheme
The colorscheme to use for syntax highlighting
Type: null or string
Default: null
Declared by:
plugins.telescope.keymaps
Keymaps for telescope.
Type: attribute set of string
Default: { }
Example:
{
"<C-p>" = "git_files";
"<leader>fg" = "live_grep";
}
Declared by:
plugins.telescope.keymapsSilent
Whether telescope keymaps should be silent
Type: boolean
Default: false
Declared by:
plugins.tmux-navigator.enable
Whether to enable Enable Tmux-Navigator (see https://github.com/christoomey/vim-tmux-navigator for tmux installation instruction).
Type: boolean
Default: false
Example: true
Declared by:
plugins.tmux-navigator.package
Plugin to use for tmux-navigator
Type: package
Default: <derivation vimplugin-vim-tmux-navigator-2023-01-10>
Declared by:
plugins.tmux-navigator.tmuxNavigatorDisableWhenZoomed
null: unzoom when moving from Vim to another pane (default value) 1: If the tmux window is zoomed, keep it zoomed when moving from Vim to another pane
Type: null or value 1 (singular enum)
Default: null
Declared by:
plugins.tmux-navigator.tmuxNavigatorNoWrap
null: move past the edge of the screen, tmux/vim will wrap around to the opposite side (default value) 1: disable wrap
Type: null or value 1 (singular enum)
Default: null
Declared by:
plugins.tmux-navigator.tmuxNavigatorSaveOnSwitch
null: don’t save on switch (default value) 1: update (write the current buffer, but only if changed) 2: wall (write all buffers)
Type: null or one of 1, 2
Default: null
Declared by:
plugins.todo-comments.enable
Whether to enable Enable todo-comments…
Type: boolean
Default: false
Example: true
Declared by:
plugins.todo-comments.package
Plugin to use for todo-comments
Type: package
Default: <derivation vimplugin-todo-comments.nvim-2023-05-22>
Declared by:
plugins.todo-comments.colors
List of named colors where we try to extract the guifg from the list of highlight groups or use the hex color if hl not found as a fallback.
Default:
{
error = [ "DiagnosticError" "ErrorMsg" "#DC2626" ];
warning = [ "DiagnosticWarn" "WarningMsg" "#FBBF24" ];
info = [ "DiagnosticInfo" "#2563EB" ];
hint = [ "DiagnosticHint" "#10B981" ];
default = [ "Identifier" "#7C3AED" ];
test = [ "Identifier" "#FF00FF" ];
};
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.todo-comments.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.todo-comments.guiStyle
The gui style for highlight groups.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.guiStyle.bg
The gui style to use for the bg highlight group.
default: BOLD
Type: null or string
Default: null
Declared by:
plugins.todo-comments.guiStyle.fg
The gui style to use for the fg highlight group.
default: NONE
Type: null or string
Default: null
Declared by:
plugins.todo-comments.highlight
Highlight options.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.highlight.after
“fg” or “bg” or empty.
default: fg
Type: null or string
Default: null
Declared by:
plugins.todo-comments.highlight.before
“fg” or “bg” or empty.
default: ``
Type: null or string
Default: null
Declared by:
plugins.todo-comments.highlight.commentsOnly
Uses treesitter to match keywords in comments only.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.todo-comments.highlight.exclude
List of file types to exclude highlighting.
Type: null or (list of string)
Default: null
Declared by:
plugins.todo-comments.highlight.keyword
“fg”, “bg”, “wide”, “wide_bg”, “wide_fg” or empty. (wide and wide_bg is the same as bg, but will also highlight surrounding characters, wide_fg acts accordingly but with fg).
default: wide
Type: null or string
Default: null
Declared by:
plugins.todo-comments.highlight.maxLineLen
Ignore lines longer than this.
default: 400
Type: null or signed integer
Default: null
Declared by:
plugins.todo-comments.highlight.multiline
Enable multiline todo comments.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.todo-comments.highlight.multilineContext
Extra lines that will be re-evaluated when changing a line.
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.todo-comments.highlight.multilinePattern
Lua pattern to match the next multiline from the start of the matched keyword.
default: ^.
Type: null or string
Default: null
Declared by:
plugins.todo-comments.highlight.pattern
Pattern or list of patterns, used for highlighting (vim regex)
default: .*<(KEYWORDS)\s*:
Type: null or string or list of string
Default: null
Declared by:
plugins.todo-comments.keymaps.todoLocList
Keymap settings for the :TodoLocList function.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.keymaps.todoLocList.cwd
Specify the directory to search for comments
Type: null or string
Default: null
Example: "~/projects/foobar"
Declared by:
plugins.todo-comments.keymaps.todoLocList.key
Key for the TodoLocList function.
Type: string
Declared by:
plugins.todo-comments.keymaps.todoLocList.keywords
Comma separated list of keywords to filter results by. Keywords are case-sensitive.
Type: null or string
Default: null
Example: "TODO,FIX"
Declared by:
plugins.todo-comments.keymaps.todoQuickFix
Keymap settings for the :TodoQuickFix function.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.keymaps.todoQuickFix.cwd
Specify the directory to search for comments
Type: null or string
Default: null
Example: "~/projects/foobar"
Declared by:
plugins.todo-comments.keymaps.todoQuickFix.key
Key for the TodoQuickFix function.
Type: string
Declared by:
plugins.todo-comments.keymaps.todoQuickFix.keywords
Comma separated list of keywords to filter results by. Keywords are case-sensitive.
Type: null or string
Default: null
Example: "TODO,FIX"
Declared by:
plugins.todo-comments.keymaps.todoTelescope
Keymap settings for the :TodoTelescope function.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.keymaps.todoTelescope.cwd
Specify the directory to search for comments
Type: null or string
Default: null
Example: "~/projects/foobar"
Declared by:
plugins.todo-comments.keymaps.todoTelescope.key
Key for the TodoTelescope function.
Type: string
Declared by:
plugins.todo-comments.keymaps.todoTelescope.keywords
Comma separated list of keywords to filter results by. Keywords are case-sensitive.
Type: null or string
Default: null
Example: "TODO,FIX"
Declared by:
plugins.todo-comments.keymaps.todoTrouble
Keymap settings for the :TodoTrouble function.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.keymaps.todoTrouble.cwd
Specify the directory to search for comments
Type: null or string
Default: null
Example: "~/projects/foobar"
Declared by:
plugins.todo-comments.keymaps.todoTrouble.key
Key for the TodoTrouble function.
Type: string
Declared by:
plugins.todo-comments.keymaps.todoTrouble.keywords
Comma separated list of keywords to filter results by. Keywords are case-sensitive.
Type: null or string
Default: null
Example: "TODO,FIX"
Declared by:
plugins.todo-comments.keymapsSilent
Whether todo-comments keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.todo-comments.keywords
Configurations for keywords to be recognized as todo comments.
Default:
{
FIX = {
icon = " "; # Icon used for the sign, and in search results.
color = "error"; # Can be a hex color, or a named color.
alt = [ "FIXME" "BUG" "FIXIT" "ISSUE" ]; # A set of other keywords that all map to this FIX keywords.
};
TODO = { icon = " "; color = "info"; };
HACK = { icon = " "; color = "warning"; };
WARN = { icon = " "; color = "warning"; alt = [ "WARNING" "XXX" ]; };
PERF = { icon = " "; alt = [ "OPTIM" "PERFORMANCE" "OPTIMIZE" ]; };
NOTE = { icon = " "; color = "hint"; alt = [ "INFO" ]; };
TEST = { icon = "⏲ "; color = "test"; alt = [ "TESTING" "PASSED" "FAILED" ]; };
};
Type: null or (attribute set of (submodule))
Default: null
Declared by:
plugins.todo-comments.keywords.<name>.alt
A set of other keywords that all map to this FIX keywords.
Type: null or (list of string)
Default: null
Declared by:
plugins.todo-comments.keywords.<name>.color
Can be a hex color, or a named color.
Type: null or string
Default: null
Declared by:
plugins.todo-comments.keywords.<name>.icon
Icon used for the sign, and in search results.
Type: null or string
Default: null
Declared by:
plugins.todo-comments.keywords.<name>.signs
Configure signs for some keywords individually.
Type: null or boolean
Default: null
Declared by:
plugins.todo-comments.mergeKeywords
When true, custom keywords will be merged with the default
default: true
Type: null or boolean
Default: null
Declared by:
plugins.todo-comments.search
Search options.
Type: null or (submodule)
Default: null
Declared by:
plugins.todo-comments.search.args
Arguments to use for the search command in list form.
Default:
[ "--color=never" "--no-heading" "--with-filename" "--line-number" "--column" ];
Type: null or (list of string)
Default: null
Declared by:
plugins.todo-comments.search.command
Command to use for searching for keywords.
default: rg
Type: null or string
Default: null
Declared by:
plugins.todo-comments.search.pattern
Regex that will be used to match keywords. Don’t replace the (KEYWORDS) placeholder.
default: \b(KEYWORDS):
Type: null or string
Default: null
Declared by:
plugins.todo-comments.signPriority
Sign priority.
default: 8
Type: null or signed integer
Default: null
Declared by:
plugins.todo-comments.signs
Show icons in the signs column.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.enable
Whether to enable toggleterm.
Type: boolean
Default: false
Example: true
Declared by:
plugins.toggleterm.package
Plugin to use for toggleterm
Type: package
Default: <derivation vimplugin-toggleterm.nvim-2023-07-05>
Declared by:
plugins.toggleterm.autoScroll
Automatically scroll to the bottom on terminal output.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.autochdir
When neovim changes it current directory the terminal will change it’s own when next it’s opened.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.closeOnExit
Close the terminal window when the process exits.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.direction
default: "vertical"
Type: null or one of “vertical”, “horizontal”, “tab”, “float”
Default: null
Declared by:
plugins.toggleterm.floatOpts.border
border = ‘single’ | ‘double’ | ‘shadow’ | ‘curved’ | … other options supported by win open. The border key is almost the same as ‘nvim_open_win’. The ‘curved’ border is a custom border type not natively supported but implemented in this plugin.
Defines the border to use for toggleterm. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: single
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.toggleterm.floatOpts.height
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.toggleterm.floatOpts.width
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.toggleterm.floatOpts.winblend
default: 3
Type: null or signed integer
Default: null
Declared by:
plugins.toggleterm.floatOpts.zindex
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.toggleterm.hideNumbers
Hide the number column in toggleterm buffers.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.highlights
Highlights which map to a highlight group name and a table of it’s values.
Example:
highlights = {
Normal = {
guibg = "<VALUE-HERE>";
};
NormalFloat = {
link = "Normal";
},
FloatBorder = {
guifg = "<VALUE-HERE>";
guibg = "<VALUE-HERE>";
};
};
Type: null or (attribute set of attribute set of string)
Default: null
Declared by:
plugins.toggleterm.insertMappings
Whether or not the open mapping applies in insert mode.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.onClose
Function to run when the terminal closes.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.onCreate
Function to run when the terminal is first created.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.onExit
Function to run when terminal process exits.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.onOpen
Function to run when the terminal opens.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.onStderr
Callback for processing output on stderr.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.onStdout
Callback for processing output on stdout.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.openMapping
Setting the open_mapping key to use for toggling the terminal(s) will set up mappings for normal mode.
Type: null or string
Default: null
Declared by:
plugins.toggleterm.persistMode
If set to true (default) the previous terminal mode will be remembered.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.persistSize
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.shadeFiletypes
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.toggleterm.shadeTerminals
|
Note
|
This option takes priority over highlights specified so if you specify Normal highlights you should set this to false. |
default: false
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.shadingFactor
The percentage by which to lighten terminal background.
Default: -30 (gets multiplied by -3 if background is light).
default: -30
Type: null or signed integer
Default: null
Declared by:
plugins.toggleterm.shell
Change the default shell.
default: vim.o.shell
Type: null or string
Default: null
Declared by:
plugins.toggleterm.size
Size of the terminal. size can be a number or function Example:
size = 20
OR
size = function(term)
if term.direction == "horizontal" then
return 15
elseif term.direction == "vertical" then
return vim.o.columns * 0.4
end
end
default: 12
Type: null or signed integer or floating point number or string
Default: null
Declared by:
plugins.toggleterm.startInInsert
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.terminalMappings
Whether or not the open mapping applies in the opened terminals.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.winbar.enabled
default: false
Type: null or boolean
Default: null
Declared by:
plugins.toggleterm.winbar.nameFormatter
default: function(term) return term.name end
Type: null or string
Default: null
Declared by:
plugins.treesitter.enable
Whether to enable tree-sitter syntax highlighting.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter.package
Plugin to use for nvim-treesitter. If using nixGrammars, it should include a withPlugins function
Type: package
Default: <derivation vimplugin-nvim-treesitter-2023-07-09>
Declared by:
plugins.treesitter.customCaptures
Custom capture group highlighting
Type: attribute set of string
Default: { }
Declared by:
plugins.treesitter.disabledLanguages
A list of languages to disable
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter.ensureInstalled
Either “all” or a list of languages
Type: value “all” (singular enum) or list of string
Default: "all"
Declared by:
plugins.treesitter.folding
Whether to enable tree-sitter based folding.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter.grammarPackages
Grammar packages to install
Type: list of package
Default:
[ <derivation ada-grammar-0.0.0+rev=ba7951a> <derivation agda-grammar-0.0.0+rev=80ea622> <derivation arduino-grammar-0.0.0+rev=787bc6e> <derivation astro-grammar-0.0.0+rev=a4535d1> <derivation awk-grammar-0.0.0+rev=476b1a0> <derivation bash-grammar-0.0.0+rev=4936467> <derivation bass-grammar-0.0.0+rev=27f110d> <derivation beancount-grammar-0.0.0+rev=358e5ec> <derivation bibtex-grammar-0.0.0+rev=ccfd77d> <derivation bicep-grammar-0.0.0+rev=3604d8c> <derivation blueprint-grammar-0.0.0+rev=7f1a5df> <derivation c-grammar-0.0.0+rev=84bdf40> <derivation c_sharp-grammar-0.0.0+rev=1648e21> <derivation cairo-grammar-0.0.0+rev=02ec146> <derivation capnp-grammar-0.0.0+rev=7d5fa4e> <derivation chatito-grammar-0.0.0+rev=3baf22e> <derivation clojure-grammar-0.0.0+rev=6e41628> <derivation cmake-grammar-0.0.0+rev=3dfc596> <derivation comment-grammar-0.0.0+rev=c9a7e2d> <derivation commonlisp-grammar-0.0.0+rev=338db38> <derivation cooklang-grammar-0.0.0+rev=5e11341> <derivation corn-grammar-0.0.0+rev=604d73c> <derivation cpon-grammar-0.0.0+rev=f4b3cbc> <derivation cpp-grammar-0.0.0+rev=0e7b7a0> <derivation css-grammar-0.0.0+rev=769203d> <derivation cuda-grammar-0.0.0+rev=c9ba632> <derivation cue-grammar-0.0.0+rev=0deecf4> <derivation d-grammar-0.0.0+rev=c2fbf21> <derivation dart-grammar-0.0.0+rev=e398400> <derivation devicetree-grammar-0.0.0+rev=d2cc332> <derivation dhall-grammar-0.0.0+rev=affb6ee> <derivation diff-grammar-0.0.0+rev=f69bde8> <derivation dockerfile-grammar-0.0.0+rev=c0a9d69> <derivation dot-grammar-0.0.0+rev=9ab8555> <derivation ebnf-grammar-0.0.0+rev=8e635b0> <derivation eex-grammar-0.0.0+rev=f742f2f> <derivation elixir-grammar-0.0.0+rev=7be3905> <derivation elm-grammar-0.0.0+rev=73edfcd> <derivation elsa-grammar-0.0.0+rev=0a66b2b> <derivation elvish-grammar-0.0.0+rev=f32711e> <derivation embedded_template-grammar-0.0.0+rev=203f7bd> <derivation erlang-grammar-0.0.0+rev=5dba13d> <derivation fennel-grammar-0.0.0+rev=5171959> <derivation firrtl-grammar-0.0.0+rev=2b5adae> <derivation fish-grammar-0.0.0+rev=f917690> <derivation foam-grammar-0.0.0+rev=7ef88a8> <derivation fortran-grammar-0.0.0+rev=31552ac> <derivation fsh-grammar-0.0.0+rev=fa33477> <derivation func-grammar-0.0.0+rev=0834e35> <derivation fusion-grammar-0.0.0+rev=19db2f4> <derivation gdscript-grammar-0.0.0+rev=03f20b9> <derivation git_config-grammar-0.0.0+rev=a01b498> <derivation git_rebase-grammar-0.0.0+rev=d8a4207> <derivation gitattributes-grammar-0.0.0+rev=577a075> <derivation gitcommit-grammar-0.0.0+rev=6856a5f> <derivation gitignore-grammar-0.0.0+rev=f4685bf> <derivation gleam-grammar-0.0.0+rev=2d5d6b0> <derivation glimmer-grammar-0.0.0+rev=d3031a8> <derivation glsl-grammar-0.0.0+rev=53ca269> <derivation go-grammar-0.0.0+rev=7a4edcb> <derivation godot_resource-grammar-0.0.0+rev=b6ef076> <derivation gomod-grammar-0.0.0+rev=4a65743> <derivation gosum-grammar-0.0.0+rev=e2ac513> <derivation gowork-grammar-0.0.0+rev=949a8a4> <derivation graphql-grammar-0.0.0+rev=5e66e96> <derivation groovy-grammar-0.0.0+rev=54c7da8> <derivation hack-grammar-0.0.0+rev=95e63e7> <derivation hare-grammar-0.0.0+rev=3d4af17> <derivation haskell-grammar-0.0.0+rev=ba0bfb0> <derivation haskell_persistent-grammar-0.0.0+rev=58a6ccf> <derivation hcl-grammar-0.0.0+rev=becebeb> <derivation heex-grammar-0.0.0+rev=2e1348c> <derivation hjson-grammar-0.0.0+rev=02fa3b7> <derivation hlsl-grammar-0.0.0+rev=ddb6082> <derivation hocon-grammar-0.0.0+rev=c390f10> <derivation hoon-grammar-0.0.0+rev=89271df> <derivation html-grammar-0.0.0+rev=d2592b0> <derivation htmldjango-grammar-0.0.0+rev=11e73eb> <derivation http-grammar-0.0.0+rev=6824a24> <derivation ini-grammar-0.0.0+rev=1a0ce07> <derivation ispc-grammar-0.0.0+rev=848e588> <derivation janet_simple-grammar-0.0.0+rev=bd9cbaf> <derivation java-grammar-0.0.0+rev=c194ee5> <derivation javascript-grammar-0.0.0+rev=5720b24> <derivation jq-grammar-0.0.0+rev=13990f5> <derivation jsdoc-grammar-0.0.0+rev=189a6a4> <derivation json-grammar-0.0.0+rev=40a81c0> <derivation json5-grammar-0.0.0+rev=5dd5cdc> <derivation jsonc-grammar-0.0.0+rev=02b0165> <derivation jsonnet-grammar-0.0.0+rev=fdc7757> <derivation julia-grammar-0.0.0+rev=784364c> <derivation kdl-grammar-0.0.0+rev=e180e05> <derivation kotlin-grammar-0.0.0+rev=2878163> <derivation lalrpop-grammar-0.0.0+rev=b7431e4> <derivation latex-grammar-0.0.0+rev=2ae2021> <derivation ledger-grammar-0.0.0+rev=8a841fb> <derivation llvm-grammar-0.0.0+rev=d47c95d> <derivation lua-grammar-0.0.0+rev=7268c1c> <derivation luadoc-grammar-0.0.0+rev=8981072> <derivation luap-grammar-0.0.0+rev=43916b0> <derivation luau-grammar-0.0.0+rev=6953cd4> <derivation m68k-grammar-0.0.0+rev=d097b12> <derivation make-grammar-0.0.0+rev=a4b9187> <derivation markdown-grammar-0.0.0+rev=936cc84> <derivation markdown_inline-grammar-0.0.0+rev=936cc84> <derivation matlab-grammar-0.0.0+rev=676117e> <derivation menhir-grammar-0.0.0+rev=db7953a> <derivation mermaid-grammar-0.0.0+rev=e26a5f8> <derivation meson-grammar-0.0.0+rev=3d6dfbd> <derivation mlir-grammar-0.0.0+rev=e2053f7> <derivation nickel-grammar-0.0.0+rev=e1d9337> <derivation ninja-grammar-0.0.0+rev=0a95cfd> <derivation nix-grammar-0.0.0+rev=14b5361> <derivation norg-grammar-0.0.0+rev=1a30509> <derivation objc-grammar-0.0.0+rev=0612ff9> <derivation ocaml-grammar-0.0.0+rev=7a61e11> <derivation ocaml_interface-grammar-0.0.0+rev=7a61e11> <derivation ocamllex-grammar-0.0.0+rev=6211855> <derivation odin-grammar-0.0.0+rev=d165dbe> <derivation org-grammar-0.0.0+rev=64cfbc2> <derivation pascal-grammar-0.0.0+rev=9e99540> <derivation passwd-grammar-0.0.0+rev=2023939> <derivation pem-grammar-0.0.0+rev=3662443> <derivation perl-grammar-0.0.0+rev=60aa138> <derivation php-grammar-0.0.0+rev=d38adb2> <derivation phpdoc-grammar-0.0.0+rev=2d20f39> <derivation pioasm-grammar-0.0.0+rev=924aada> <derivation po-grammar-0.0.0+rev=d6aed22> <derivation poe_filter-grammar-0.0.0+rev=80dc101> <derivation pony-grammar-0.0.0+rev=16f930b> <derivation prisma-grammar-0.0.0+rev=eca2596> <derivation proto-grammar-0.0.0+rev=42d82fa> <derivation prql-grammar-0.0.0+rev=02b1e96> <derivation pug-grammar-0.0.0+rev=884e225> <derivation puppet-grammar-0.0.0+rev=843868b> <derivation python-grammar-0.0.0+rev=36f9e33> <derivation ql-grammar-0.0.0+rev=bd08702> <derivation qmldir-grammar-0.0.0+rev=6b2b5e4> <derivation qmljs-grammar-0.0.0+rev=35ead5b> <derivation query-grammar-0.0.0+rev=3a9808b> <derivation r-grammar-0.0.0+rev=80efda5> <derivation racket-grammar-0.0.0+rev=92bf637> <derivation rasi-grammar-0.0.0+rev=371dac6> <derivation regex-grammar-0.0.0+rev=e1cfca3> <derivation rego-grammar-0.0.0+rev=b2667c9> <derivation rnoweb-grammar-0.0.0+rev=502c112> <derivation ron-grammar-0.0.0+rev=ce6086b> <derivation rst-grammar-0.0.0+rev=a41a933> <derivation ruby-grammar-0.0.0+rev=f257f3f> <derivation rust-grammar-0.0.0+rev=0a70e15> <derivation scala-grammar-0.0.0+rev=8062487> <derivation scheme-grammar-0.0.0+rev=ca8af22> <derivation scss-grammar-0.0.0+rev=c478c68> <derivation slint-grammar-0.0.0+rev=00c8a2d> <derivation smali-grammar-0.0.0+rev=72e334b> <derivation smithy-grammar-0.0.0+rev=cf8c7eb> <derivation solidity-grammar-0.0.0+rev=1680203> <derivation sparql-grammar-0.0.0+rev=05f949d> <derivation sql-grammar-0.0.0+rev=dd5fe77> <derivation squirrel-grammar-0.0.0+rev=e8b5835> <derivation starlark-grammar-0.0.0+rev=504ddd7> <derivation supercollider-grammar-0.0.0+rev=3b35bd0> <derivation surface-grammar-0.0.0+rev=f4586b3> <derivation svelte-grammar-0.0.0+rev=697bb51> <derivation swift-grammar-0.0.0+rev=56ecc99> <derivation sxhkdrc-grammar-0.0.0+rev=440d5f9> <derivation t32-grammar-0.0.0+rev=4e581fc> <derivation tablegen-grammar-0.0.0+rev=e5e046e> <derivation teal-grammar-0.0.0+rev=2158ecc> <derivation terraform-grammar-0.0.0+rev=becebeb> <derivation thrift-grammar-0.0.0+rev=d4deb1b> <derivation tiger-grammar-0.0.0+rev=4a09924> <derivation tlaplus-grammar-0.0.0+rev=7ba226c> <derivation todotxt-grammar-0.0.0+rev=0207f6a> <derivation toml-grammar-0.0.0+rev=8bd2056> <derivation tsx-grammar-0.0.0+rev=3429d8c> <derivation turtle-grammar-0.0.0+rev=085437f> <derivation twig-grammar-0.0.0+rev=779ee5a> <derivation typescript-grammar-0.0.0+rev=3429d8c> <derivation ungrammar-grammar-0.0.0+rev=debd26f> <derivation usd-grammar-0.0.0+rev=718a6b3> <derivation uxntal-grammar-0.0.0+rev=14e4760> <derivation v-grammar-0.0.0+rev=e14fdf6> <derivation vala-grammar-0.0.0+rev=8f690bf> <derivation verilog-grammar-0.0.0+rev=22f9b84> <derivation vhs-grammar-0.0.0+rev=fec6e98> <derivation vim-grammar-0.0.0+rev=26b1aea> <derivation vimdoc-grammar-0.0.0+rev=c0f8580> <derivation vue-grammar-0.0.0+rev=91fe275> <derivation wgsl-grammar-0.0.0+rev=40259f3> <derivation wgsl_bevy-grammar-0.0.0+rev=7cd38d6> <derivation wing-grammar-0.0.0+rev=8b4843a> <derivation yaml-grammar-0.0.0+rev=0e36bed> <derivation yang-grammar-0.0.0+rev=2c0e6be> <derivation yuck-grammar-0.0.0+rev=c348825> <derivation zig-grammar-0.0.0+rev=0d08703> ]
Declared by:
plugins.treesitter.ignoreInstall
List of parsers to ignore installing (for “all”)
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter.incrementalSelection.enable
Whether to enable incremental selection based on the named nodes from the grammar.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter.incrementalSelection.keymaps.initSelection
This option has no description.
Type: string
Default: "gnn"
Declared by:
plugins.treesitter.incrementalSelection.keymaps.nodeDecremental
This option has no description.
Type: string
Default: "grm"
Declared by:
plugins.treesitter.incrementalSelection.keymaps.nodeIncremental
This option has no description.
Type: string
Default: "grn"
Declared by:
plugins.treesitter.incrementalSelection.keymaps.scopeIncremental
This option has no description.
Type: string
Default: "grc"
Declared by:
plugins.treesitter.indent
Whether to enable tree-sitter based indentation.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter.languageRegister
This is a wrapping of the vim.treesitter.language.register function. Register specific parsers to one or several filetypes. The keys are the parser names and the values are either one or several filetypes.
Type: attribute set of (string or list of string)
Default: { }
Example:
{
cpp = "onelab";
python = [
"myFiletype"
"anotherFiletype"
];
}
Declared by:
plugins.treesitter.moduleConfig
This is the configuration for extra modules. It should not be used directly
Type: attribute set of anything
Default: { }
Declared by:
plugins.treesitter.nixGrammars
Install grammars with Nix
Type: boolean
Default: true
Declared by:
plugins.treesitter.nixvimInjections
Whether to enable nixvim specific injections, like lua highlighting in extraConfigLua.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter.parserInstallDir
Location of the parsers to be installed by the plugin (only needed when nixGrammars is disabled). This default might not work on your own install, please make sure that $XDG_DATA_HOME is set if you want to use the default. Otherwise, change it to something that will work for you!
Type: null or string
Default: null
Declared by:
plugins.treesitter-context.enable
Whether to enable nvim-treesitter-context.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-context.package
Plugin to use for treesitter-context
Type: package
Default: <derivation vimplugin-nvim-treesitter-context-2023-06-29>
Declared by:
plugins.treesitter-context.exactPatterns
Treat the coresponding entry in patterns as an exact match
Type: attribute set of boolean
Default: { }
Declared by:
plugins.treesitter-context.maxLines
How many lines the window should span. Null means no limit
Type: null or positive integer, meaning >0
Default: null
Declared by:
plugins.treesitter-context.maxWindowHeight
Minimum editor window height to enable context
Type: null or positive integer, meaning >0
Default: null
Declared by:
plugins.treesitter-context.patterns
Patterns to use for context delimitation. The ‘default’ key matches all filetypes
Type: attribute set of list of string
Default: { }
Declared by:
plugins.treesitter-context.trimScope
Which context lines to discard if max_lines is exceeded
Type: one of “outer”, “inner”
Default: "outer"
Declared by:
plugins.treesitter-playground.enable
Whether to enable nvim-treesitter-playground.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-playground.package
Plugin to use for treesitter-playground
Type: package
Default: <derivation vimplugin-playground-2023-04-15>
Declared by:
plugins.treesitter-playground.disabledLanguages
A list of languages where this module should be disabled
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.treesitter-playground.keybindings
Keybindings inside the Playground
Type: null or (submodule)
Default: null
Declared by:
plugins.treesitter-playground.keybindings.focusLanguage
Focus language
default: f
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.gotoNode
Go to node
default: <cr>
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.showHelp
Show help
default: ?
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.toggleAnonymousNodes
Toggle anonymous nodes
default: a
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.toggleHlGroups
Toggle highlight groups
default: i
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.toggleInjectedLanguages
Toggle injected languages
default: t
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.toggleLanguageDisplay
Toggle language display
default: I
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.toggleQueryEditor
Toggle query editor
default: o
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.unfocusLanguage
Unfocus language
default: F
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.keybindings.update
Update
default: R
Type: null or string
Default: null
Declared by:
plugins.treesitter-playground.persistQueries
Whether the query persists across vim sessions
default: false
Type: null or boolean
Default: null
Declared by:
plugins.treesitter-playground.updateTime
Debounced time for highlighting nodes in the playground from source code
default: 25
Type: null or signed integer
Default: null
Declared by:
plugins.treesitter-rainbow.enable
Whether to enable treesitter-rainbow.
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-rainbow.package
Plugin to use for treesitter-rainbow
Type: package
Default: <derivation vimplugin-nvim-ts-rainbow2-2023-07-09>
Declared by:
plugins.treesitter-rainbow.disable
List of languages you want to disable the plugin for.
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.treesitter-rainbow.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.treesitter-rainbow.hlgroups
The list of highlight groups to apply.
default: [ "TSRainbowRed" "TSRainbowYellow" "TSRainbowBlue" "TSRainbowOrange" "TSRainbowGreen" "TSRainbowViolet" "TSRainbowCyan" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.treesitter-rainbow.query
The query to use for finding delimiters.
default: rainbow-parens
Type: null or string
Default: null
Declared by:
plugins.treesitter-rainbow.strategy
The query to use for finding delimiters. Directly provide lua code.
default: require('ts-rainbow').strategy.global
Type: null or string
Default: null
Declared by:
plugins.treesitter-refactor.enable
Whether to enable treesitter-refactor (requires plugins.treesitter.enable to be true).
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-refactor.package
Plugin to use for treesitter-refactor
Type: package
Default: <derivation vimplugin-nvim-treesitter-refactor-2023-04-04>
Declared by:
plugins.treesitter-refactor.highlightCurrentScope.enable
Whether to enable highlights the block from the current scope where the cursor is…
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-refactor.highlightCurrentScope.disable
List of languages to disable the module on
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter-refactor.highlightDefinitions.enable
Whether to enable Highlights definition and usages of the current symbol under the cursor…
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-refactor.highlightDefinitions.clearOnCursorMove
Controls if highlights should be cleared when the cursor is moved. If your ‘updatetime’ is around 100 you can set this to false to have a less laggy experience.
Type: boolean
Default: true
Declared by:
plugins.treesitter-refactor.highlightDefinitions.disable
List of languages to disable the module on
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter-refactor.navigation.enable
Whether to enable Provides “go to definition” for the symbol under the cursor, and lists the definitions from the current file. .
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-refactor.navigation.disable
List of languages to disable the module on
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter-refactor.navigation.keymaps.gotoDefinition
go to the definition of the symbol under the cursor
Type: null or string
Default: "gnd"
Declared by:
plugins.treesitter-refactor.navigation.keymaps.gotoDefinitionLspFallback
go to the definition of the symbol under the cursor or use vim.lsp.buf.definition if the symbol can not be resolved. You can use your own fallback function if create a mapping fo lua require'nvim-treesitter.refactor.navigation(nil, fallback_function)<cr>.
Type: null or string
Default: null
Declared by:
plugins.treesitter-refactor.navigation.keymaps.gotoNextUsage
go to next usage of identifier under the cursor
Type: null or string
Default: "<a-*>"
Declared by:
plugins.treesitter-refactor.navigation.keymaps.gotoPreviousUsage
go to previous usage of identifier
Type: null or string
Default: "<a-#>"
Declared by:
plugins.treesitter-refactor.navigation.keymaps.listDefinitons
list all definitions from the current file
Type: null or string
Default: "gnD"
Declared by:
plugins.treesitter-refactor.navigation.keymaps.listDefinitonsToc
list all definitions from the current file like a table of contents (similar to the one you see when pressing |gO| in help files).
Type: null or string
Default: "gO"
Declared by:
plugins.treesitter-refactor.smartRename.enable
Whether to enable Renames the symbol under the cursor within the current scope (and current file)…
Type: boolean
Default: false
Example: true
Declared by:
plugins.treesitter-refactor.smartRename.disable
List of languages to disable the module on
Type: list of string
Default: [ ]
Declared by:
plugins.treesitter-refactor.smartRename.keymaps.smartRename
rename symbol under the cursor
Type: null or string
Default: "grr"
Declared by:
plugins.trouble.enable
Whether to enable trouble.nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.trouble.package
Plugin to use for trouble-nvim
Type: package
Default: <derivation vimplugin-trouble.nvim-2023-06-24>
Declared by:
plugins.trouble.actionKeys
Key mappings for actions in the trouble list. Map to {} to remove a mapping, for example: close = {};
Type: null or (submodule)
Default: null
Declared by:
plugins.trouble.actionKeys.cancel
Cancel the preview and get back to your last window / buffer / cursor
default: <esc>
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.close
Close the list
default: q
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.closeFolds
Close all folds
default: [ "zM" "zm" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.hover
Opens a small popup with the full multiline message
default: K
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.jump
Jump to the diagnostic or open / close folds
default: [ "<cr>" "<tab>" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.jumpClose
Jump to the diagnostic and close the list
default: [ "o" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.next
Next item
default: j
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.openFolds
Open all folds
default: [ "zR" "zr" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.openSplit
Open buffer in new split
default: [ "<c-x>" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.openTab
Open buffer in new tab
default: [ "<c-t>" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.openVsplit
Open buffer in new vsplit
default: [ "<c-v>" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.preview
Preview the diagnostic location
default: p
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.previous
Previous item
default: k
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.refresh
Manually refresh
default: r
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.toggleFold
Toggle fold of current file
default: [ "zA" "za" ]
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.toggleMode
toggle between ‘workspace’ and ‘document’ diagnostics mode
default: m
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.actionKeys.togglePreview
Toggle auto_preview
default: P
Type: null or string or list of string
Default: null
Declared by:
plugins.trouble.autoClose
Automatically close the list when you have no diagnostics.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.trouble.autoFold
Automatically fold a file trouble list at creation.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.trouble.autoJump
For the given modes, automatically jump if there is only a single result.
default: [ "lsp_definitions" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.trouble.autoOpen
Automatically open the list when you have diagnostics.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.trouble.autoPreview
Automatically preview the location of the diagnostic. <esc> to close preview and go back to last window.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.trouble.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.trouble.foldClosed
Icon used for closed folds
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.foldOpen
Icon used for open folds
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.group
Group results by file
default: true
Type: null or boolean
Default: null
Declared by:
plugins.trouble.height
Height of the trouble list when position is top or bottom
default: 10
Type: null or signed integer
Default: null
Declared by:
plugins.trouble.icons
Use devicons for filenames
default: true
Type: null or boolean
Default: null
Declared by:
plugins.trouble.indentLines
Add an indent guide below the fold icons.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.trouble.mode
Use devicons for filenames
default: "workspace_diagnostics"
Type: null or one of “workspace_diagnostics”, “document_diagnostics”, “quickfix”, “lsp_references”, “loclist”
Default: null
Declared by:
plugins.trouble.padding
Add an extra new line on top of the list
default: true
Type: null or boolean
Default: null
Declared by:
plugins.trouble.position
Position of the list
default: "bottom"
Type: null or one of “top”, “left”, “right”, “bottom”
Default: null
Declared by:
plugins.trouble.signs
Incons/text used for the different diagnostics.
Type: null or (submodule)
Default: null
Declared by:
plugins.trouble.signs.error
Icon/text for error diagnostics.
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.signs.hint
Icon/text for hint diagnostics.
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.signs.information
Icon/text for information diagnostics.
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.signs.other
Icon/text for other diagnostics.
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.signs.warning
Icon/text for warning diagnostics.
default:
Type: null or string
Default: null
Declared by:
plugins.trouble.useDiagnosticSigns
Enabling this will use the signs defined in your lsp client
default: false
Type: null or boolean
Default: null
Declared by:
plugins.trouble.width
Width of the list when position is left or right
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.ts-autotag.enable
Whether to enable nvim-ts-autotag.
Type: boolean
Default: false
Example: true
Declared by:
plugins.ts-autotag.package
Plugin to use for ts-autotag
Type: package
Default: <derivation vimplugin-nvim-ts-autotag-2023-06-16>
Declared by:
plugins.ts-autotag.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.ts-autotag.filetypes
Filetypes for which ts-autotag should be enabled.
default: [ "html" "javascript" "typescript" "javascriptreact" "typescriptreact" "svelte" "vue" "tsx" "jsx" "rescript" "xml" "php" "markdown" "astro" "glimmer" "handlebars" "hbs" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.ts-autotag.skipTags
Which tags to skip.
default: [ "area" "base" "br" "col" "command" "embed" "hr" "img" "slot" "input" "keygen" "link" "meta" "param" "source" "track" "wbr" "menuitem" ]
Type: null or (list of string)
Default: null
Declared by:
plugins.ts-context-commentstring.enable
Whether to enable nvim-ts-context-commentstring.
Type: boolean
Default: false
Example: true
Declared by:
plugins.ts-context-commentstring.package
Plugin to use for ts-context-commentstring
Type: package
Default: <derivation vimplugin-nvim-ts-context-commentstring-2023-06-22>
Declared by:
plugins.ts-context-commentstring.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.typst-vim.enable
Whether to enable typst.vim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.typst-vim.package
Plugin to use for typst-vim
Type: package
Default: <derivation vimplugin-typst.vim-2023-07-02>
Declared by:
plugins.typst-vim.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.typst-vim.keymaps.silent
Whether typst-vim keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.typst-vim.keymaps.watch
Keymap to preview the document and recompile on change.
Type: null or string
Default: null
Declared by:
plugins.undotree.enable
Whether to enable Enable undotree.
Type: boolean
Default: false
Example: true
Declared by:
plugins.undotree.package
Plugin to use for undotree
Type: package
Default: <derivation vimplugin-undotree-2023-07-07>
Declared by:
plugins.undotree.autoOpenDiff
Auto open diff window
Type: boolean
Default: true
Declared by:
plugins.undotree.diffCommand
Diff command
Type: null or string
Default: null
Declared by:
plugins.undotree.diffHeight
Undotree diff panel height
Type: null or signed integer
Default: null
Declared by:
plugins.undotree.focusOnToggle
Focus undotree after being opened
Type: boolean
Default: false
Declared by:
plugins.undotree.highlightChangedText
Highlight changed text
Type: boolean
Default: true
Declared by:
plugins.undotree.highlightChangesWithSign
Highlight changes with a sign in the gutter
Type: boolean
Default: true
Declared by:
plugins.undotree.highlightSyntaxAdd
Added lines highlight group
Type: null or string
Default: null
Declared by:
plugins.undotree.highlightSyntaxChange
Changed lines highlight group
Type: null or string
Default: null
Declared by:
plugins.undotree.highlightSyntaxDel
Deleted lines highlight group
Type: null or string
Default: null
Declared by:
plugins.undotree.relativeTimestamp
Use a relative timestamp
Type: boolean
Default: true
Declared by:
plugins.undotree.shortIndicators
E.g. use ‘d’ instead of ‘days’
Type: boolean
Default: false
Declared by:
plugins.undotree.showCursorLine
Show cursor line
Type: boolean
Default: true
Declared by:
plugins.undotree.showHelpLine
Show help line
Type: boolean
Default: true
Declared by:
plugins.undotree.treeNodeShape
Tree node shape
Type: null or string
Default: null
Declared by:
plugins.undotree.windowLayout
Window layout for undotree. Check https://github.com/mbbill/undotree/blob/master/plugin/undotree.vim#L29 for reference
Type: null or signed integer
Default: null
Declared by:
plugins.undotree.windowWidth
Undotree window width
Type: null or signed integer
Default: null
Declared by:
plugins.vim-bbye.enable
Whether to enable vim-bbye.
Type: boolean
Default: false
Example: true
Declared by:
plugins.vim-bbye.package
Plugin to use for vim-bbye
Type: package
Default: <derivation vimplugin-vim-bbye-2018-03-03>
Declared by:
plugins.vim-bbye.keymaps.bdelete
Keymap for deleting the current buffer.";
Type: null or string
Default: null
Declared by:
plugins.vim-bbye.keymaps.bwipeout
Keymap for completely deleting the current buffer.";
Type: null or string
Default: null
Declared by:
plugins.vim-bbye.keymapsSilent
Whether vim-bbye keymaps should be silent.
Type: boolean
Default: false
Declared by:
plugins.vim-matchup.enable
Whether to enable Enable vim-matchup.
Type: boolean
Default: false
Example: true
Declared by:
plugins.vim-matchup.enableSurround
To enable the delete surrounding (ds%) and change surrounding (cs%) maps
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.enableTransmute
To enable the experimental transmute module
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.package
Plugin to use for vim-matchup
Type: package
Default: <derivation vimplugin-vim-matchup-2023-06-30>
Declared by:
plugins.vim-matchup.delimNoSkips
To disable matching within strings and comments:
-
0: matching is enabled within strings and comments
-
1: recognize symbols within comments
-
2: don’t recognize anything in comments
default: 0
Type: null or one of 0, 1, 2
Default: null
Declared by:
plugins.vim-matchup.delimStopline
To configure the number of lines to search in either direction while using motions and text objects. Does not apply to match highlighting (see matchParenStopline instead)
default: 1500
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.matchParen.enable
Control matching parentheses
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.deffered.enable
Deferred highlighting improves cursor movement performance (for example, when using hjkl) by delaying highlighting for a short time and waiting to see if the cursor continues moving
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.deffered.hideDelay
Adjust delays in milliseconds for deferred highlighting
default: 700
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.matchParen.deffered.showDelay
Adjust delays in milliseconds for deferred highlighting
default: 50
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.matchParen.fallback
If matchParen is not enabled fallback to the standard vim matchparen.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.hiSurroundAlways
Highlight surrounding delimiters always as the cursor moves Note: this feature requires deferred highlighting to be supported and enabled.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.insertTimeout
Adjust timeouts in milliseconds for matchparen highlighting
default: 60
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.matchParen.offscreen
Dictionary controlling the behavior with off-screen matches.
default: {method = "status";}
Type: null or (submodule)
Default: null
Declared by:
plugins.vim-matchup.matchParen.offscreen.method
‘status’: Replace the status-line for off-screen matches.
If a match is off of the screen, the line belonging to that match will be displayed syntax-highlighted in the status line along with the line number (if line numbers are enabled). If the match is above the screen border, an additional Δ symbol will be shown to indicate that the matching line is really above the cursor line.
‘popup’: Show off-screen matches in a popup (vim) or floating (neovim) window.
‘status_manual’: Compute the string which would be displayed in the status-line or popup, but do not display it. The function MatchupStatusOffscreen() can be used to get the text.
default: "status"
Type: null or one of “status”, “popup”, “status_manual”
Default: null
Declared by:
plugins.vim-matchup.matchParen.offscreen.scrolloff
When enabled, off-screen matches will not be shown in the statusline while the cursor is at the screen edge (respects the value of ‘scrolloff’). This is intended to prevent flickering while scrolling with j and k.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.singleton
Whether to highlight known words even if there is no match
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.matchParen.stopline
The number of lines to search in either direction while highlighting matches. Set this conservatively since high values may cause performance issues.
default: 400
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.matchParen.timeout
Adjust timeouts in milliseconds for matchparen highlighting
default: 300
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.motion.enable
Control motions
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.motion.cursorEnd
If enabled, cursor will land on the end of mid and close words while moving downwards (%/]%). While moving upwards (g%, [%) the cursor will land on the beginning.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.motion.overrideNPercent
In vim, {count}% goes to the {count} percentage in the file. match-up overrides this motion for small {count} (by default, anything less than 7). To allow {count}% for {count} less than 12 set overrideNPercent to 11.
To disable this feature set it to 0.
To always enable this feature, use any value greater than 99
default: 6
Type: null or signed integer
Default: null
Declared by:
plugins.vim-matchup.textObj.enable
Controls text objects
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.textObj.linewiseOperators
Modify the set of operators which may operate line-wise
default: ["d" "y"]
Type: null or (list of string)
Default: null
Declared by:
plugins.vim-matchup.treesitterIntegration.enable
Whether to enable Enable treesitter integration.
Type: boolean
Default: false
Example: true
Declared by:
plugins.vim-matchup.treesitterIntegration.disable
Languages for each to disable this module
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.vim-matchup.treesitterIntegration.disableVirtualText
Do not use virtual text to highlight the virtual end of a block, for languages without explicit end markers (e.g., Python).
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-matchup.treesitterIntegration.includeMatchWords
Additionally include traditional vim regex matches for symbols. For example, highlights /* */ comments in C++ which are not supported in tree-sitter matching
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-slime.enable
Whether to enable vim-slime.
Type: boolean
Default: false
Example: true
Declared by:
plugins.vim-slime.package
Plugin to use for vim-slime
Type: package
Default: <derivation vimplugin-vim-slime-2023-06-23>
Declared by:
plugins.vim-slime.bracketedPaste
Sometimes REPL are too smart for their own good, e.g. autocompleting a bracket that should not be autocompleted when pasting code from a file. In this case it can be useful to rely on bracketed-paste (https://cirw.in/blog/bracketed-paste);. Luckily, tmux knows how to handle that. See tmux’s manual.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-slime.defaultConfig
Pre-filled prompt answer.
Examples:
-
tmux:{ socket_name = "default"; target_pane = "{last}"; } -
zellij:{ session_id = "current"; relative_pane = "right"; }
default: null
Type: null or (attribute set of (string or (submodule)))
Default: null
Declared by:
plugins.vim-slime.dontAskDefault
Whether to bypass the prompt and use the specified default configuration options.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-slime.extraConfig
The configuration options for vim-slime without the ‘slime_’ prefix. Example: To set ‘slime_foobar’ to 1, write extraConfig = { foobar = true; };
Type: attribute set
Default: { }
Declared by:
plugins.vim-slime.noMappings
Whether to disable the default mappings.
default: false
Type: null or boolean
Default: null
Declared by:
plugins.vim-slime.pasteFile
Required to transfer data from vim to GNU screen or tmux. Setting this explicitly can work around some occasional portability issues. whimrepl does not require or support this setting.
default: $HOME/.slime_paste
Type: null or string
Default: null
Declared by:
plugins.vim-slime.preserveCurpos
Whether to preserve cursor position when sending a line or paragraph.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.vim-slime.target
Which backend vim-slime should use.
default: "screen"
Type: null or one of “dtach”, “kitty”, “neovim”, “screen”, “tmux”, “vimterminal”, “wezterm”, “whimrepl”, “x11”, “zellij”
Default: null
Declared by:
plugins.vim-slime.vimterminalCmd
The vim terminal command to execute.
Type: null or string
Default: null
Declared by:
plugins.vimtex.enable
Whether to enable vimtex.
Type: boolean
Default: false
Example: true
Declared by:
plugins.vimtex.package
Plugin to use for vimtex
Type: package
Default: <derivation vimplugin-vimtex-2023-07-05>
Declared by:
plugins.vimtex.extraConfig
The configuration options for vimtex without the ‘vimtex_’ prefix. Example: To set ‘vimtex_compiler_enabled’ to 1, write extraConfig = { compiler_enabled = true; };
Type: attribute set
Default: { }
Declared by:
plugins.which-key.enable
Whether to enable which-key.nvim, a plugin that popup with possible key bindings of the command you started typing.
Type: boolean
Default: false
Example: true
Declared by:
plugins.which-key.package
Plugin to use for whick-key-nvim
Type: package
Default: <derivation vimplugin-which-key.nvim-2023-06-19>
Declared by:
plugins.which-key.disable.buftypes
Disabled by default for Telescope
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.which-key.disable.filetypes
default: []
Type: null or (list of string)
Default: null
Declared by:
plugins.which-key.hidden
hide mapping boilerplate
default: ["<silent>" "<cmd>" "<Cmd>" "<CR>" "^:" "^ " "^call " "^lua "]
Type: null or (list of string)
Default: null
Declared by:
plugins.which-key.icons.breadcrumb
symbol used in the command line area that shows your active key combo
default: »
Type: null or string
Default: null
Declared by:
plugins.which-key.icons.group
symbol prepended to a group
default: +
Type: null or string
Default: null
Declared by:
plugins.which-key.icons.separator
symbol used between a key and it’s label
default: ➜
Type: null or string
Default: null
Declared by:
plugins.which-key.ignoreMissing
enable this to hide mappings for which you didn’t specify a label
default: false
Type: null or boolean
Default: null
Declared by:
plugins.which-key.keyLabels
override the label used to display some keys. It doesn’t effect WK in any other way.
default: {}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.which-key.layout.align
default: "left"
Type: null or one of “left”, “center”, “right”
Default: null
Declared by:
plugins.which-key.layout.height
min and max height of the columns
default: {min = 4; max = 25;}
Type: null or (submodule)
Default: null
Declared by:
plugins.which-key.layout.height.max
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.layout.height.min
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.layout.spacing
spacing between columns
default: 3
Type: null or signed integer
Default: null
Declared by:
plugins.which-key.layout.width
min and max width of the columns
default: {min = 20; max = 50;}
Type: null or (submodule)
Default: null
Declared by:
plugins.which-key.layout.width.max
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.layout.width.min
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.motions.count
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.operators
add operators that will trigger motion and text object completion to enable all native operators, set the preset / operators plugin above
default: {gc = "Comments";}
Type: null or (attribute set of string)
Default: null
Declared by:
plugins.which-key.plugins.marks
shows a list of your marks on ’ and `
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.g
bindings for prefixed with g
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.motions
adds help for motions
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.nav
misc bindings to work with windows
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.operators
adds help for operators like d, y, …
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.textObjects
help for text objects triggered after entering an operator
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.windows
default bindings on <c-w>
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.presets.z
bindings for folds, spelling and others prefixed with z
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.registers
shows your registers on " in NORMAL or <C-r> in INSERT mode
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.spelling.enabled
enabling this will show WhichKey when pressing z= to select spelling suggestions
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.plugins.spelling.suggestions
how many suggestions should be shown in the list?
default: 20
Type: null or signed integer
Default: null
Declared by:
plugins.which-key.popupMappings.scrollDown
binding to scroll down inside the popup
default: <c-d>
Type: null or string
Default: null
Declared by:
plugins.which-key.popupMappings.scrollUp
binding to scroll up inside the popup
default: <c-u>
Type: null or string
Default: null
Declared by:
plugins.which-key.showHelp
show a help message in the command line for using WhichKey
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.showKeys
show the currently pressed key and its label as a message in the command line
default: true
Type: null or boolean
Default: null
Declared by:
plugins.which-key.triggers
automatically setup triggers, or specifiy a list manually
default: "auto"
Type: null or value “auto” (singular enum) or list of string
Default: null
Declared by:
plugins.which-key.triggersBlackList
list of mode / prefixes that should never be hooked by WhichKey this is mostly relevant for keymaps that start with a native binding
default: { i = ["j" "k"]; v = ["j" "k"]}}
Type: null or (attribute set of list of string)
Default: null
Declared by:
plugins.which-key.triggersNoWait
list of triggers, where WhichKey should not wait for timeoutlen and show immediately
default: ["" “'” "g" "g'" "\"" "<c-r>" "z="]
Type: null or (list of string)
Default: null
Declared by:
plugins.which-key.window.border
Defines the border to use for which-key. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.
default: none
Type: null or string or list of string or list of list of string
Default: null
Declared by:
plugins.which-key.window.margin
extra window margin
default: {top = 1; right = 0; bottom = 1; left = 0;}
Type: null or (submodule)
Default: null
Declared by:
plugins.which-key.window.margin.bottom
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.margin.left
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.margin.right
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.margin.top
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.padding
extra window padding
default: {top = 1; right = 2; bottom = 1; left = 2;}
Type: null or (submodule)
Default: null
Declared by:
plugins.which-key.window.padding.bottom
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.padding.left
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.padding.right
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.padding.top
This option has no description.
Type: signed integer
Declared by:
plugins.which-key.window.position
default: "bottom"
Type: null or one of “bottom”, “top”
Default: null
Declared by:
plugins.which-key.window.winblend
0 for fully opaque and 100 for fully transparent
default: 0
Type: null or integer between 0 and 100 (both inclusive)
Default: null
Declared by:
plugins.wilder-nvim.enable
Whether to enable wilder-nvim.
Type: boolean
Default: false
Example: true
Declared by:
plugins.wilder-nvim.enableCmdlineEnter
If true calls wilder#enable_cmdline_enter(). Creates a new |CmdlineEnter| autocmd to which will start wilder when the cmdline is entered.
default: true
Type: null or boolean
Default: null
Declared by:
plugins.wilder-nvim.package
Plugin to use for wilder-nvim
Type: package
Default: <derivation vimplugin-wilder.nvim-2022-08-13>
Declared by:
plugins.wilder-nvim.acceptCompletionAutoSelect
The auto_slect option passed to wilder#accept_completion().
default: true
Type: null or boolean
Default: null
Declared by:
plugins.wilder-nvim.acceptKey
Mapping to bind to wilder#accept_completion().
default: <Down>
Type: null or string
Default: null
Declared by:
plugins.wilder-nvim.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.wilder-nvim.modes
List of modes which wilderw will be active in. Possible elements: ‘/’, ‘?’ and ‘:’
default: ["/" "?"]
Type: null or (list of string)
Default: null
Declared by:
plugins.wilder-nvim.nextKey
A key to map to wilder#next() providing next suggestion.
default: <Tab>
Type: null or string
Default: null
Declared by:
plugins.wilder-nvim.prevKey
A key to map to wilder#prev() providing previous suggestion.
default: <S-Tab>
Type: null or string
Default: null
Declared by:
plugins.wilder-nvim.rejectKey
Mapping to bind to wilder#reject_completion().
default: <Up>
Type: null or string
Default: null
Declared by:
plugins.wilder-nvim.wildcharm
Key to set the ‘wildcharm’ option to. can be set to v:false to skip the setting.
default: &wildchar
Type: null or string
Default: null
Declared by:
plugins.zig.enable
Whether to enable Enable zig.
Type: boolean
Default: false
Example: true
Declared by:
plugins.zig.package
Plugin to use for zig
Type: package
Default: <derivation vimplugin-zig.vim-2023-06-23>
Declared by:
plugins.zig.formatOnSave
Run zig fmt on save
Type: null or boolean
Default: null
Example: null
Declared by:
plugins.zk.enable
Whether to enable zk.nvim, a plugin to integrate with zk.
Type: boolean
Default: false
Example: true
Declared by:
plugins.zk.package
Plugin to use for zk.nvim
Type: package
Default: <derivation vimplugin-zk-nvim-2023-07-09>
Declared by:
plugins.zk.lsp.autoAttach.enabled
automatically attach buffers in a zk notebook
default: true
Type: null or boolean
Default: null
Declared by:
plugins.zk.lsp.autoAttach.filetypes
matching the given filetypes
default: ["markdown"]
Type: null or (list of string)
Default: null
Declared by:
plugins.zk.lsp.config.cmd
default: ["zk" "lsp"]
Type: null or (list of string)
Default: null
Declared by:
plugins.zk.lsp.config.extraOptions
These attributes will be added to the table parameter for the setup function. (Can override other attributes set by nixvim)
Type: attribute set
Default: { }
Declared by:
plugins.zk.lsp.config.name
default: zk
Type: null or string
Default: null
Declared by:
plugins.zk.picker
it’s recommended to use “telescope” or “fzf”
default: "select"
Type: null or one of “select”, “fzf”, “telescope”
Default: null
Declared by:
type
Whether the generated file is a vim or a lua file
Type: one of “vim”, “lua”
Default: "lua"
Declared by:
userCommands
A list of user commands to add to the configuration
Type: attribute set of (submodule)
Default: { }
Declared by:
userCommands.<name>.addr
Whether special characters relate to other things, see :h command-addr.
Type: null or string
Default: null
Declared by:
userCommands.<name>.bang
Whether this command can take a bang (!)
default: false
Type: null or boolean
Default: null
Declared by:
userCommands.<name>.bar
Whether this command can be followed by a “|” and another command
default: false
Type: null or boolean
Default: null
Declared by:
userCommands.<name>.command
The command to run
Type: string
Declared by:
userCommands.<name>.complete
Tab-completion behaviour, see :h command-complete.
Type: null or string or (submodule)
Default: null
Declared by:
userCommands.<name>.count
Whether the command accepts a count, see :h command-range.
Type: null or boolean or signed integer
Default: null
Declared by:
userCommands.<name>.desc
A description of the command
default: ``
Type: null or string
Default: null
Declared by:
userCommands.<name>.force
Overwrite an existing user command
default: false
Type: null or boolean
Default: null
Declared by:
userCommands.<name>.keepscript
Do not use the location of where the user command was defined for verbose messages, use the location of where the command was invoked
default: false
Type: null or boolean
Default: null
Declared by:
userCommands.<name>.nargs
The number of arguments to expect, see :h command-nargs.
Type: null or one of “0”, “1”, “*”, “?”, “+”
Default: null
Declared by:
userCommands.<name>.range
Whether the command accepts a range, see :h command-range.
Type: null or boolean or signed integer or value “%” (singular enum)
Default: null
Declared by:
userCommands.<name>.register
The first argument to the command can be an optional register
default: false
Type: null or boolean
Default: null
Declared by: